diff options
Diffstat (limited to 'CLAUDE.md')
| -rw-r--r-- | CLAUDE.md | 35 |
1 files changed, 31 insertions, 4 deletions
@@ -1,9 +1,29 @@ # Claude Code Project Guidelines ## Project Overview -A unified web dashboard aggregating Trello (PRIMARY), Todoist, Obsidian, and PlanToEat. +A unified web dashboard aggregating Trello (PRIMARY), Todoist, Obsidian, and PlanToEat. **Stack:** Go backend + HTMX + Tailwind CSS + SQLite. +## Key Documents (Read These First) + +| Document | Purpose | When to Read | +|----------|---------|--------------| +| `DESIGN.md` | Authoritative design doc: architecture, patterns, visual design, dev guide | Before any significant work | +| `SESSION_STATE.md` | Current task state, next steps | Start of every session | +| `docs/adr/*.md` | Architecture Decision Records | Before implementing features in that area | + +### Multi-Agent Workflow + +This project uses a three-role development workflow. **Read your role definition before starting work:** + +| Role | Definition File | Responsibilities | +|------|-----------------|------------------| +| Architect | `ARCHITECT_ROLE.md` | Plans, documents, creates ADRs. Does NOT edit code. | +| Implementor | `IMPLEMENTOR_ROLE.md` | Executes plans, writes code, runs tests. | +| Reviewer | `REVIEWER_ROLE.md` | Reviews code quality and tests. Does NOT edit code. | + +**Handoff docs:** `instructions.md` (Architect → Implementor), `review_feedback.md` (Reviewer → Implementor) + ## Efficiency & Token Management - **Context Minimization:** Do not read entire files if `grep`, `sed`, or `ls` can answer a question. - **Surgical Edits:** Perform small, targeted file edits. Avoid rewriting entire files for single changes. @@ -22,19 +42,26 @@ A unified web dashboard aggregating Trello (PRIMARY), Todoist, Obsidian, and Pla - **Build:** `go build -o dashboard cmd/dashboard/main.go` ## State Management -- **SESSION_STATE.md:** The source of truth for resuming work. It must include: +- **SESSION_STATE.md:** The source of truth for resuming work. Must include: - Current Task Goal - Completed Items - - Architecture Decisions - **Next 3 Specific Steps** +- **Status tags:** `[TODO]` → `[IN_PROGRESS]` → `[REVIEW_READY]` → `[APPROVED]` (or `[NEEDS_FIX]`) ## Technical Context - **Trello is PRIMARY:** Key + Token required in query params. -- **Architecture:** chi router -> Handlers (`internal/handlers/`) -> Store (`internal/store/sqlite.go`). +- **Architecture:** chi router → Handlers (`internal/handlers/`) → Store (`internal/store/sqlite.go`). - **Errors:** Partial data/cache fallback preferred over hard failure. +- **Full details:** See `DESIGN.md` → Architecture section. ## Coding Style - Use concise, idiomatic Go. - Avoid verbose explanations or comments for self-evident logic. - Prioritize terminal-based verification over manual code review. +- **Patterns:** See `DESIGN.md` → Development Guide for handler/template patterns. + +## Documentation +- **ADR-first:** Capture architectural decisions in `docs/adr/*.md`, not one-off design docs. +- **Update DESIGN.md** for new features, endpoints, or schema changes. +- **Do NOT create** standalone design documents—use ADRs instead. |