Merge pull request #5 from shokinn/codex/create-agents.md-from-memory-bank

docs: add project agents guidance
This commit is contained in:
Philip Henning 2025-08-14 08:29:04 +02:00 committed by GitHub
commit ef5c2a9da8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

26
AGENTS.md Normal file
View file

@ -0,0 +1,26 @@
# AGENTS
## Memory Bank Requirements
- **Always read the Memory Bank before starting any task.**
- Memory Bank lives in `memory-bank/` and contains:
- `projectbrief.md`
- `productContext.md`
- `systemPatterns.md`
- `techContext.md`
- `activeContext.md`
- `progress.md`
- The Memory Bank is the single source of project context. If a user requests **update memory bank**, review every file in the directory before making changes.
- After significant work or when insights are gained, update `activeContext.md` and `progress.md`. Create additional files in `memory-bank/` when useful for organizing new documentation.
## Development Guidelines
- **Language:** Go using modules.
- **Formatting:** run `gofmt -w` on modified Go files.
- **Testing:** practice TDD and run `go test ./...` before committing.
- **Linting:** run `golangci-lint run` when available.
- **Structure:** keep application code inside `internal/` packages and follow existing patterns for `core`, `tui`, and `utils`.
- **Error Handling:** return errors instead of panicking and provide clear messages.
## Commit Process
- Ensure Memory Bank is updated when project state changes.
- Run the formatting, lint, and test commands above.
- Commit only when the worktree is clean and all commands pass.