docs: consolidate CLAUDE.md into AGENTS.md#40
Conversation
Merge all CLAUDE.md content (Toolchain section, make commands, running examples, test conventions) into AGENTS.md so there is a single source of truth. CLAUDE.md now delegates to AGENTS.md via @AGENTS.md.
There was a problem hiding this comment.
Pull request overview
Consolidates contributor/agent guidance by merging unique content from CLAUDE.md into AGENTS.md and leaving CLAUDE.md as a single pointer to the canonical document.
Changes:
- Added Toolchain details, additional commands, and test seeding/placement conventions to
AGENTS.md. - Replaced the contents of
CLAUDE.mdwith a single reference toAGENTS.md. - Fixed the documented
go vetinvocation to use./....
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CLAUDE.md | Replaced full guidance with a single reference to AGENTS.md as the source of truth. |
| AGENTS.md | Added consolidated toolchain/commands/conventions content and corrected go vet documentation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Task | Command | | ||
| |------|---------| | ||
| | Run | `go run ./cmd/dashboard -db path/to/receipts.db` | | ||
| | Run (custom port) | `./dashboard -db path/to/receipts.db -port 9090` | |
There was a problem hiding this comment.
Quick reference mixes go run for the basic Run command with ./dashboard for the custom-port Run command. ./dashboard will fail unless the binary has already been built in the repo root. Suggest making both Run commands consistent (either both go run ./cmd/dashboard ... or both ./dashboard ... / dashboard ... with an explicit build/install prerequisite).
| | Run (custom port) | `./dashboard -db path/to/receipts.db -port 9090` | | |
| | Run (custom port) | `go run ./cmd/dashboard -db path/to/receipts.db -port 9090` | |
| - Run `go vet ./...` and `go test ./...` before committing | ||
| - Tests sit alongside source files as `*_test.go` | ||
| - Write tests before implementation (TDD) | ||
| @AGENTS.md |
There was a problem hiding this comment.
@AGENTS.md is not rendered as a clickable link on GitHub and isn’t a standard include directive in Markdown. If the intention is to redirect human readers, consider using a normal Markdown link (e.g. "See AGENTS.md") or otherwise clarify that this is a tool-specific include directive.
| @AGENTS.md | |
| See [AGENTS.md](AGENTS.md). |
|
|
||
| ## Toolchain | ||
|
|
||
| - **Language:** Go 1.22+ |
There was a problem hiding this comment.
Toolchain section says Go 1.22+, but this repo’s go.mod specifies go 1.26.1 (and CONTRIBUTING.md also mentions 1.26+). Update this to match the actual minimum supported Go version to avoid misleading setup instructions.
| - **Language:** Go 1.22+ | |
| - **Language:** Go 1.26+ |
Summary
CLAUDE.mdintoAGENTS.md(Toolchain section,makecommands, running examples with custom port, and test placement/seeding conventions)CLAUDE.mdnow contains only@AGENTS.md— a single reference so there is one source of truth to maintaingo vetcommand was missing the./...argument in AGENTS.mdTest plan
AGENTS.mdcontains all content previously inCLAUDE.mdCLAUDE.mdcontains only@AGENTS.md