- Notifications
You must be signed in to change notification settings - Fork1.1k
docs: improve code comment guidelines for AI agents#20952
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Merged
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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
Add comprehensive commenting standards to CLAUDE.md focusing on:- Proper sentence structure with punctuation- Explaining rationale rather than describing code- 80-character line width with natural wrappingThese guidelines help AI agents write more professional and maintainablecomments that align with project standards.---🤖 This change was written by Claude Sonnet 4.5 Thinking using [mux](https://github.com/coder/mux) and reviewed by a human 🏂
Uh oh!
There was an error while loading.Please reload this page.
Replace OAuth2/AsSystemRestricted example with a clearer timeout examplethat better demonstrates the difference between why-focused vs what-focusedcomments and proper formatting vs awkward one-sentence-per-line style.
ThomasK33 approved these changesNov 26, 2025
bcc74b2 intomain 29 checks passed
Uh oh!
There was an error while loading.Please reload this page.
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
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.
This PR enhances the CLAUDE.md document with comprehensive guidelines for writing better code comments, specifically targeted at AI agents and LLM-generated code.
Changes
Example
The guidelines include before/after examples showing the difference between well-formatted, meaningful comments and poorly written ones.
Impact
These standards will help ensure AI-generated code includes professional, maintainable comments that align with project conventions.
🤖 This change was written by Claude Sonnet 4.5 Thinking usingmux and reviewed by a human 🏂