feat: enforce default no comments - #4444
Conversation
PR SummaryLow Risk Overview The Code quality section now requires self-explanatory code (naming and extraction over explanation), lists when comments are allowed (external workarounds, non-obvious invariants, performance constraints, unavoidable legacy complexity, ticketed Reviewed by Cursor Bugbot for commit 04f3d10. Bugbot is set up for automated code reviews on this repo. Configure here. |
|
Your PR title doesn't contain a Jira issue key. Consider adding it for better traceability. Example:
Projects:
Please add a Jira issue key to your PR title. |
There was a problem hiding this comment.
Pull request overview
Strengthens project guidance to discourage explanatory code comments and define narrow exceptions.
Changes:
- Requires self-explanatory code.
- Defines allowed comment categories and a two-line limit.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
24e9295 to
04f3d10
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
CLAUDE.md:76
- The exhaustive exception list omits mandatory copyright/SPDX license headers, even though this repository treats missing license headers as a review violation. As written, assistants may avoid adding or remove required headers. Explicitly exempt required license headers.
- A comment is allowed ONLY if one of these is true, and the reason cannot be
expressed in code:
- workaround for an external bug/API quirk (link it)
Summary
enforce default no comments
Type of change