docs: discourage redundant internal comments - #8656
Open
philipphofmann wants to merge 2 commits into
Open
Conversation
philipphofmann
marked this pull request as ready for review
August 3, 2026 14:37
philipphofmann
requested review from
NinjaLikesCheez,
itaybre,
noahsmartin and
philprime
as code owners
August 3, 2026 14:37
philipphofmann
added
the
run-full-ci
9 tasks
philprime
approved these changes
Aug 3, 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
3 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.
Codifies that internal code should not carry comments that merely restate what the code does — only why-comments (rationale, workaround, gotcha) and public headerdocs.
Sources/AGENTS.md— authoring rule (new### Commentssubsection)REVIEWS.md— enforcement bullet for review agents, cross-linked#skip-changelog
Closes #8657