Skip to content

docs(agents): tighten code-comment rule to short, why-only#883

Merged
AmethystLiang merged 1 commit intomainfrom
our-ai-gives-too-wordy-of-an-comment-now-label-e
Apr 21, 2026
Merged

docs(agents): tighten code-comment rule to short, why-only#883
AmethystLiang merged 1 commit intomainfrom
our-ai-gives-too-wordy-of-an-comment-now-label-e

Conversation

@AmethystLiang
Copy link
Copy Markdown
Contributor

Summary

  • AI agents were generating wordy multi-paragraph "Why:" comments. Updated AGENTS.md §Code Comments to require short (1–2 line) comments that capture only the non-obvious reason — no restating what the code does, narrating mechanism, or verbatim design-doc citations.

Test plan

  • AGENTS.md renders correctly

@AmethystLiang AmethystLiang merged commit 8ea1f2e into main Apr 21, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant