Skip to content

Commit 4cf1165

Browse files
authored
docs: reject explanatory implementation comments (#2087)
1 parent bf26ab1 commit 4cf1165

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ Versioned CLI help is the source of truth for command behavior. Start workflow p
3636
- Repair recurring failures at their owning interface with types, a registry, or one construction
3737
path. A custom guard that reconstructs another source of truth needs redesign, not another
3838
exception.
39+
- Treat explanatory implementation comments as a failed design review. Do not narrate control flow,
40+
preserve review history, or justify a workaround in code. Express the invariant through names,
41+
types, module boundaries, and tests; put history in the PR or an ADR. Allow only public API docs,
42+
tool directives, and a brief citation to an external constraint that cannot be encoded.
3943
- Key behavior on typed reasons and details, never error text. Existing message sniffs are owned debt
4044
and must not be copied.
4145
- Snapshot output is the token budget: do not add per-node metadata when response-level metadata can

0 commit comments

Comments
 (0)