promote(org): comments-explain-why - #8
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a standard markdown entry defining metadata and guidance for writing comments that explain non-obvious rationale rather than restating visible code. ChangesComment Guidelines
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
Comment |
voidhrithik
approved these changes
Jul 21, 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
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.
Adds an org Standard covering code comments - the one gap where agents reliably add noise and nothing in the commons said not to.
The only existing entry matching "comment" is
review-comments-inline-and-human, which is about PR review comments. Nothing governed comments in source.The rule
Never write a comment that explains what the code already says. Comment only what a reader cannot recover from the file: discovered external-system behaviour, a workaround with a link and a removal condition, a non-obvious invariant or ordering constraint.
Scope
Write-time only, deliberately:
scoped-diffs.simplest-code-that-worksalready governs extraction.The closing line names AI diffs explicitly, since narrating every block is their default and this is where most of the noise comes from.
Notes
roboto-mem lintis clean forentries/org/. Thememory-cicheck will still be red - it runs a barelintand ~30 pre-existingentries/skills/**files fail as unknown scope / missing frontmatter. That predates this branch.Summary by CodeRabbit