From 3f794786b62be349090571b8a242d56f6f899838 Mon Sep 17 00:00:00 2001 From: Philip Henning Date: Thu, 14 Aug 2025 08:28:49 +0200 Subject: [PATCH] docs: add project agents guidance --- AGENTS.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..51f8cb6 --- /dev/null +++ b/AGENTS.md @@ -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.