One page per area: frontend UI, agent, workflows, daemon (task lifecycle and event automation together), State Store, control plane and settings, and processes and wiring, with merging work kept separate.
2.5 KiB
2.5 KiB
Development guides
Checklists for changing Archie, one page per area. Each names every place a
change must reach, so a feature that works in one layer does not silently stop
at the next. A change that spans areas starts on the page for the area it
begins in, which points to the others. The pages point at the documents that
own the design (docs/architecture/, the PRDs, CLAUDE.md) rather than
restating them.
| Area | Covers |
|---|---|
| Frontend UI | Anything under ui/, and the dashboard's API routes |
| Agent | The agent container, its image, profiles, tools and workspace |
| Workflows | Workflow definitions and step types |
| Daemon | Task statuses, fields and the brief; sources, event types, mappings and bindings |
| State Store | Stored fields, tables, RPCs and errors |
| Control plane and settings | Settings in config.toml or the dashboard |
| Processes and wiring | Where code goes, processes, plugin engines, channels, NATS subjects |
| Merging work | Merging a lane or a branch |
Every change
- Write the failing test first for anything with logic, branching or a contract, and check it fails on an assertion, not a compile error.
- Test through the path production uses. A test that sets a value directly on the consumer proves nothing about the layers that normally deliver it.
- Run
task checkand let its exit status decide the commit:task check && git commit ....task testpasses-short, which skips the process and Postgres tests, so rungo test -count=1 ./cmd/... ./internal/...too when a change crosses a process or the database. - Regenerate, never hand-edit, generated output:
task proto:generate,go -C tools tool sqlc generate -f $PWD/internal/infrastructure/postgres/sqlc.yaml,task ui,task docs:artifact.task proto:checkcompares against the git index, so stage regenerated contracts before running it. - Stage by path, or read
git statusbeforegit add -A. Tests that start embedded NATS or write logs must uset.TempDir(); anything they leave in the tree gets committed.task checkalso adds linter-tool lines togo.sum(bead 1e37); restorego.sumbefore committing unless you changed a dependency. - A change to
docs/prds/ordocs/architecture/carries the regenerateddocs/data/generated/dev-docs.json, and PRD edits followdocs/prds/RULES.mdand passtask docs:prds.