Skip to content

Commit a7b0a5f

Browse files
Brian M HuntBrian M Hunt
authored andcommitted
docs: tighten AGENTS.md Plans + Before-you-start sections
1 parent f68cc67 commit a7b0a5f

1 file changed

Lines changed: 11 additions & 23 deletions

File tree

AGENTS.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ Two things shape the coverage/safety bar here more than any specific rule:
1717

1818
Together: coverage and signal are expensive to lose and cheap to keep. When a change trades either away, say so explicitly and justify the delta.
1919

20-
## Before you start (checklist)
20+
## Before you start
2121

22-
1. **Check `plans/` first.** A significant change (new page, new build step, new CI workflow, new top-level concept, multi-commit refactor) needs a plan file in [`plans/`](plans/) *before implementation*see the [Plans](#plans) section below. If the task matches an existing plan, read it; if not and the scope is significant, draft one and get alignment.
23-
2. **Check verified-behaviors.** If the change touches a package with `verified-behaviors.json`, the behaviors are a contract — preserve them unless the plan explicitly calls for a revision.
24-
3. **Run `bun run verify`** before any commit. It's the safety net.
22+
- Check [`plans/`](plans/)significant changes need a plan before code (see [Plans](#plans)).
23+
- `verified-behaviors.json` in a package is a contract; don't break it without a plan.
24+
- `bun run verify` passes before every commit.
2525

2626
## Project Structure
2727

@@ -162,27 +162,15 @@ long-lived publish token.
162162

163163
## Plans
164164

165-
Significant changes need a plan file in [`plans/`](plans/) **before
166-
implementation begins**. Plans document the context, approach, architecture,
167-
files touched, and verification steps. Existing plans are the format reference
168-
— match their shape.
165+
Significant changes need a plan in [`plans/`](plans/) before code. Plans
166+
document context, approach, files touched, and verification. Match the shape
167+
of existing plans.
169168

170-
**Write a plan when the change is any of:**
169+
**Write one for:** new pages/routes, new build or CI steps, new cross-package
170+
concepts, refactors across 5+ files.
171171

172-
- a new top-level page, route, or site feature (e.g. `/playground`, `/tests`)
173-
- a new build, bundling, or release step
174-
- a new CI workflow or check
175-
- a new cross-package concept (e.g. verified-behaviors, defineOption)
176-
- a refactor touching 5+ files across packages
177-
- anything you'd describe to a teammate as "this is a project, not a fix"
178-
179-
**Skip a plan for:** bug fixes, single-file edits, doc tweaks, dependency
180-
bumps, comment cleanup, test additions to an existing spec.
181-
182-
If unsure, check `plans/` for precedent — the existing plans span docs
183-
migrations, build modernization, playground, test runner, agent-verified
184-
behaviors, and more. If nothing comparable is there, the change probably
185-
deserves a plan.
172+
**Skip for:** bug fixes, single-file edits, doc tweaks, dep bumps, comment
173+
cleanup, new tests in existing specs.
186174

187175
## Agent-First Documentation
188176

0 commit comments

Comments
 (0)