Skip to content

Commit 948378f

Browse files
authored
Merge pull request #12 from cs-util/v9
V9
2 parents 75fe6fd + d664b76 commit 948378f

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44
- You must follow the instructions in the `AGENTS.md` file while working on your task and regularly review if you are still aligned with these instructions and the spec.
55
- Do not stop until every acceptance criterion is implemented, verified locally and prepared for review.
66
- **Co-locate docs**: every code file must have a matching `*.md` sidecar next to it, that explains the component in detail. The goal of the sidecar is to make purpose, API, invariants, examples and test strategy of the component obvious to agents and humans.
7-
87
- This is a minimal local first web app (static HTML + modular JS). Prefer tailwind over custom CSS.
98
- Entrypoint: `index.html` (+ static pages in `pages/` if any needed)
109
- The code is composed of small, focused modules in `src/` (`components/`, `utils/`, ..) with colocated tests
11-
- Run `npm test` and `npm outdated` at the start and end of each significant task and weekly at minimum; keep dependencies healthy. Prefer bumping to the `Wanted` version unless blocked by incompatibilities (document any exceptions). Also run `npm audit` to catch security issues even when versions are current
10+
- Do exactly one prioritized task per iteration and work in a TDD approach where possible.
11+
- Before and after any change, run `npm test`
12+
- Run `npm outdated` weekly at minimum; keep dependencies healthy. Prefer bumping to the `Wanted` version unless blocked by incompatibilities (document any exceptions). Also run `npm audit` to catch security issues even when versions are current.
1213
- Only change code directly related to the current task; keep diffs small!
1314
- Preserve existing comments & docs; add concise, long-lived comments where useful and avoid narrating changes via comments
1415
- When external documentation could be consulted, do so to validate your plan makes sense. If you lack a browsing/online search tool, ask the user to run an online search for you (e.g., "Please search for \"x\" and paste back the findings")
16+
- Before adding functionality, search the codebase (e.g., ripgrep) to confirm it's truly absent. If present, prefer refactor over re-implementation.
17+
- After each iteration add a concise update at the end of docs/implementation-progress.md to use it as the memory between iterations for learnings, decisions, planning etc.
1518

1619
## Dependencies & no-build approach to use
1720

@@ -36,6 +39,7 @@ Do requirements gathering before implementation
3639
- Reduce risks from assumptions (no matter how sure you are) by **proving these assumptions with tests**.
3740
Do not throw away the produced tests after you did the validation, because they often serve as useful documentation of a behavior. Make sure their comments explain their purpose.
3841
- **TDD by default.** Interfaces emerge from tests.
42+
- When adding/updating tests, keep a brief "why this test matters" comment in the test so future iterations can better decide to modify/keep/remove.
3943

4044
## TDD Loop
4145

0 commit comments

Comments
 (0)