Skip to content

feat: enforce default no comments - #4444

Merged
ulemons merged 1 commit into
mainfrom
fix/enforece-few-comments
Aug 5, 2026
Merged

feat: enforce default no comments#4444
ulemons merged 1 commit into
mainfrom
fix/enforece-few-comments

Conversation

@ulemons

@ulemons ulemons commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

enforce default no comments

Type of change

  • Bug fix
  • New feature
  • Refactor / cleanup
  • Performance improvement
  • Chore / dependency update
  • Documentation

@ulemons ulemons self-assigned this Aug 5, 2026
Copilot AI balanced review requested due to automatic review settings August 5, 2026 11:04
@ulemons ulemons added the Feature Created by Linear-GitHub Sync label Aug 5, 2026
@cursor

cursor Bot commented Aug 5, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only change to AI/contributor guidelines; no runtime or application code is modified.

Overview
Tightens contributor guidance in CLAUDE.md from a short “default to no comments” note to an explicit no-comments policy with narrow exceptions.

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 TODO(CM-XXX)), and forbids routine comments (what the code does, section headers, obvious JSDoc, change notes). Allowed comments stay capped at two lines.

Reviewed by Cursor Bugbot for commit 04f3d10. Bugbot is set up for automated code reviews on this repo. Configure here.

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

⚠️ Jira Issue Key Missing

Your PR title doesn't contain a Jira issue key. Consider adding it for better traceability.

Example:

  • feat: add user authentication (CM-123)
  • feat: add user authentication (IN-123)

Projects:

  • CM: Community Data Platform
  • IN: Insights

Please add a Jira issue key to your PR title.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CLAUDE.md

@skwowet skwowet left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LTGM

Signed-off-by: Umberto Sgueglia <usgueglia@contractor.linuxfoundation.org>
Copilot AI review requested due to automatic review settings August 5, 2026 11:09
@ulemons
ulemons force-pushed the fix/enforece-few-comments branch from 24e9295 to 04f3d10 Compare August 5, 2026 11:09

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@ulemons
ulemons merged commit c279f16 into main Aug 5, 2026
10 checks passed
@ulemons
ulemons deleted the fix/enforece-few-comments branch August 5, 2026 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Feature Created by Linear-GitHub Sync

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants