Skip to content

Add comment policy to Code Style in CLAUDE.md#506

Merged
jlamypoirier merged 1 commit intomainfrom
jlp_add-comment-policy-to-code-style
May 1, 2026
Merged

Add comment policy to Code Style in CLAUDE.md#506
jlamypoirier merged 1 commit intomainfrom
jlp_add-comment-policy-to-code-style

Conversation

@jlamypoirier
Copy link
Copy Markdown
Collaborator

Summary

  • The PR review checklist already flagged comments that restate obvious code, but the Code Style section had no comment guidance
  • Coder sessions read Code Style to guide generation and found no constraint, defaulting to verbose comments; reviewer sessions then flagged them
  • Adds an explicit Comments entry to Code Style so both sides apply the same rule

Test plan

  • Verify coder sessions now produce minimal comments in new code
  • Verify reviewer sessions continue to flag excessive comments

🤖 Generated with Claude Code

The PR review checklist already flagged comments that restate obvious
code, but the Code Style section had no comment guidance. Coder sessions
read Code Style to guide generation and found no constraint, so they
defaulted to verbose comments; reviewer sessions then flagged them. Add
an explicit Comments entry so both sides apply the same rule.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jlamypoirier jlamypoirier merged commit 0f6958f into main May 1, 2026
4 checks passed
@jlamypoirier jlamypoirier deleted the jlp_add-comment-policy-to-code-style branch May 1, 2026 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant