Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,6 @@ what tooling can't check.
it starts a name. File names are unaffected: kebab-case lowercases everything (`parse-cli-args.ts`
exports `parseCLIArgs`).

### Comments

- Comments that document a declaration are JSDoc blocks, always multi-line (`/**` alone, one
`*`-prefixed line per point, `*/` alone — never single-line `/** … */`), attached directly to the
declaration they describe; `//` is for statement-level commentary inside bodies.
- Comment a declaration only for what the file doesn't already show — an invariant, cross-file or
runtime behavior, or why the choice is necessary. A comment that restates the name or signature is
a defect — delete it.
- Comments describe the code as it is now — no history ("previously", "now uses"), no project state
(issue numbers, phase labels, "not wired yet"); those live in the commit message.
- Comments don't name other declarations — renames strand the reference. State the contract instead:
"callers must pass edits sorted last-to-first", not "(buildEditsFromAST's contract)". A
declaration's own parameters and signature types are fine to name.

### Function naming

Every function name starts with a prefix from the closed list below: pick from it, or extend this
Expand Down
14 changes: 0 additions & 14 deletions agents/shared.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,6 @@ what tooling can't check.
it starts a name. File names are unaffected: kebab-case lowercases everything (`parse-cli-args.ts`
exports `parseCLIArgs`).

### Comments

- Comments that document a declaration are JSDoc blocks, always multi-line (`/**` alone, one
`*`-prefixed line per point, `*/` alone — never single-line `/** … */`), attached directly to the
declaration they describe; `//` is for statement-level commentary inside bodies.
- Comment a declaration only for what the file doesn't already show — an invariant, cross-file or
runtime behavior, or why the choice is necessary. A comment that restates the name or signature is
a defect — delete it.
- Comments describe the code as it is now — no history ("previously", "now uses"), no project state
(issue numbers, phase labels, "not wired yet"); those live in the commit message.
- Comments don't name other declarations — renames strand the reference. State the contract instead:
"callers must pass edits sorted last-to-first", not "(buildEditsFromAST's contract)". A
declaration's own parameters and signature types are fine to name.

### Function naming

Every function name starts with a prefix from the closed list below: pick from it, or extend this
Expand Down