docs: add code comment guidelines to AGENTS.md and update rule#27729
Merged
dhairyashiil merged 2 commits intomainfrom Feb 7, 2026
Merged
docs: add code comment guidelines to AGENTS.md and update rule#27729dhairyashiil merged 2 commits intomainfrom
dhairyashiil merged 2 commits intomainfrom
Conversation
Co-Authored-By: eunjae@cal.com <hey@eunjae.dev>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
… AGENTS.md Co-Authored-By: eunjae@cal.com <hey@eunjae.dev>
dhairyashiil
approved these changes
Feb 7, 2026
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
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.
What does this PR do?
Adds code comment guidelines to
AGENTS.mdto prevent AI-generated comments that simply restate what the code does. This was prompted by team feedback:Changes to AGENTS.md (kept lean, referencing the dedicated rule file):
Changes to agents/rules/quality-code-comments.md:
No functional code changes — documentation only.
How should this be tested?
N/A — this is a documentation change to AI agent guidelines. Verify that the wording and examples align with the team's expectations for comment quality.
Human Review Checklist
agents/rules/quality-code-comments.mdrenders correctlyMandatory Tasks (DO NOT REMOVE)