docs(agents): add a comment style section to the repo guide - #581
Merged
Conversation
Agents default to narrating every line, which buries the load-bearing comments in noise. Codify why-not-what, the deletion test, and the narration patterns to avoid.
mnoah1
marked this pull request as ready for review
August 12, 2026 15:24
mnoah1
requested review from
a team,
behinddwalls and
sbalabanov
as code owners
August 12, 2026 15:24
behinddwalls
approved these changes
Aug 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Agents default to narrating every line, which buries the load-bearing comments in noise. Codify why-not-what, the deletion test, and the narration patterns to avoid.
Why?
Repo is getting too comment heavy with comments that just narrate functionality instead of providing core info.