docs: add code comments guideline to agents guide#22
Open
aayushshah15 wants to merge 1 commit intomasterfrom
Open
docs: add code comments guideline to agents guide#22aayushshah15 wants to merge 1 commit intomasterfrom
aayushshah15 wants to merge 1 commit intomasterfrom
Conversation
Co-authored-by: Codesmith <codesmith@blacksmith.sh>
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
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.
Summary
Adds a Code Style section to AGENTS.md with a guideline encouraging contributors to write concise comments that explain the "why" (rationale) when it isn't obvious from the code itself — without over-commenting obvious logic. Examples include non-obvious business rules, workarounds, performance trade-offs, or constraints that would require digging through history to understand.
View Codesmith session
Note
Low Risk
Documentation-only change adding a code commenting guideline; no runtime or behavioral impact.
Overview
Adds a new Code Style section to
AGENTS.mdthat sets expectations for comments: avoid stating the obvious, but document the rationale (“why”) behind non-obvious decisions (e.g., business rules, workarounds, performance trade-offs, constraints).Written by Cursor Bugbot for commit 0486571. This will update automatically on new commits. Configure here.