Skip to content

Commit 1508c9a

Browse files
committed
Add instructions for coding agents
1 parent 0e736c7 commit 1508c9a

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# AGENTS.md (repo root)
2+
3+
## Defaults (apply to every task)
4+
- Prefer minimal, reviewable diffs.
5+
- Keep changes aligned with existing patterns and conventions in this repo.
6+
- If you add/change business logic (not UI), also add/update tests.
7+
- If you change UI, update storybook accordingly.
8+
9+
## Required checks before you finish
10+
Run these before marking the task done (unless explicitly told not to):
11+
1) Lint + typecheck
12+
- `yarn lint`
13+
- `yarn typecheck` (or `yarn tsc`)
14+
15+
2) Unit tests
16+
- `yarn test --watchman=false`
17+
18+
3) Storybook (only if UI/components changed)
19+
- Ensure story files are updated/added.
20+
- If component API or visuals changed: add/update stories and any relevant snapshots.
21+
22+
## When you should run what
23+
- Pure refactor / no behavior change: lint + typecheck only, tests if risk is non-trivial.
24+
- Any logic change: lint + typecheck + tests.
25+
- Any UI/component change: lint + typecheck + tests + story updates (and storybook tests if available).
26+
27+
## Output expectations
28+
- Summarize what changed and why.
29+
- List the commands you ran and their result.
30+
- Call out any follow-ups you did NOT do (and why).

0 commit comments

Comments
 (0)