Skip to content

Commit f19b67d

Browse files
committed
docs: teach how to plan
1 parent bd9c95d commit f19b67d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

AGENTS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,18 @@ This document helps AI agents work effectively in this codebase. It explains the
66

77
This is a minimal, idiomatic WebSocket library. Simplicity is a feature. Before adding code, consider whether it's necessary. Before adding a dependency, don't; tests requiring external packages are isolated in `internal/thirdparty`.
88

9+
## Planning
10+
11+
When asked to plan, write to `PLAN.md`. Write for someone else, not yourself; don't skip context you already know. Research deeply before proposing solutions.
12+
13+
**Follow references.** If there's a link, issue, or RFC citation, read it. Document important findings in a research section so the implementer can verify.
14+
15+
**Focus on what and why.** Provide enough context for the implementer to understand the problem and constraints. Code examples can illustrate intent, but don't over-specify; leave room for the implementer to find a better approach.
16+
17+
**Tell them where to look.** Point to specific files, functions, or line numbers. Make claims verifiable.
18+
19+
**Review before finishing.** Make a final pass to check for gaps in research or unanswered questions, then update the document.
20+
921
## Research
1022

1123
**Read the issue carefully.** Before designing a solution, verify you understand what's actually being requested. Restate the problem in your own words. A solution to the wrong problem wastes everyone's time.

0 commit comments

Comments
 (0)