Skip to content

Commit 8a54e4b

Browse files
committed
docs(agents): bound code-comment length, not just its topic
The Conciseness rule constrained what a comment may say ("non-obvious intent") and never how long — the only length bound sat under the docs clause, so a 20-line header on a new file passed it. That is how one got written in a sibling repo. The clause now names length and audience: a block arguing for its own change is a commit message, and long evidence belongs in the project's agent docs.
1 parent f292728 commit 8a54e4b

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

‎AGENTS.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ pnpm run release:preview # print the changelog the next release would get
6666
## Conciseness
6767

6868
**Prune verbose, keep correctness** — code, comments, docs alike. A comment only for non-obvious
69-
intent; docs one idea per sentence, cut what would not change what a reader does. Delete history
69+
intent, and short — a block arguing for its own change is a commit message; docs one idea per
70+
sentence, cut what would not change what a reader does. Delete history
7071
`git log` already holds — keep the rule, not the story. Never drop a caveat to save a line.
7172

7273
## User-facing docs

0 commit comments

Comments
 (0)