docs: add lean-comments guideline to CLAUDE.md - #2914
Open
lbondaryk wants to merge 1 commit into
Open
Conversation
Codifies review feedback: comment only when it adds information the code doesn't convey; avoid restating code/names/test descriptions; prefer fewer, higher-value comments. AI-generated code tends to over-comment. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## master #2914 +/- ##
===========================================
- Coverage 85.98% 68.78% -17.20%
===========================================
Files 918 913 -5
Lines 52713 52689 -24
Branches 13940 13938 -2
===========================================
- Hits 45324 36244 -9080
- Misses 7373 16413 +9040
- Partials 16 32 +16
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
collaborative-learning
 |
||||||||||||||||||||||||||||
| Project |
collaborative-learning
|
| Branch Review |
docs-lean-comments-guideline
|
| Run status |
|
| Run duration | 03m 36s |
| Commit |
|
| Committer | Leslie Bondaryk |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
 |
0
|
 |
0
|
 |
0
|
 |
0
|
 |
4
|
| View all changes introduced in this branch ↗︎ | |
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
1 participant
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 a Comments entry to
CLAUDE.md→ Key Patterns, codifying review feedback that AI-authored PRs tend to over-comment:Since
CLAUDE.mdis always loaded by Claude Code in this repo, this steers future AI-assisted editing to produce leaner comments up front, reducing the review cleanup Teale has been doing (e.g. on #2907).🤖 Generated with Claude Code