Skip to content

Commit 1cba3d9

Browse files
committed
Update AGENTS.md for consistency and clarity in README references
1 parent 232d26e commit 1cba3d9

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

AGENTS.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# General
22

3-
- The readme.md contains the full spec of the application. Read it end-to-end to understand the full context.
4-
- You must follow the instructions in the agent.md file while working on your task and regularly review if you are still aligned with these instructions and the spec.
3+
- The `README.md` contains the full spec of the application. Read it end-to-end to understand the full context. It should be kept up to date whenever the code is ready for a PR
4+
- 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.
77

88
- This is a minimal local first web app (static HTML + modular JS). Prefer tailwind over custom CSS.
99
- Entrypoint: `index.html` (+ static pages in `pages/` if any needed)
1010
- The code is composed of small, focused modules in `src/` (`components/`, `utils/`, ..) with colocated tests
1111
- 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
12-
- `README.md` typically contains big picture dev. spec and context. It should be kept up to date whenever the code is ready for a PR
1312
- Only change code directly related to the current task; keep diffs small!
1413
- Preserve existing comments & docs; add concise, long-lived comments where useful and avoid narrating changes via comments
1514
- 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")

0 commit comments

Comments
 (0)