Skip to content

docs: Tighten PR-description and comment guidance in AGENTS.md - #24329

Merged
mydea merged 1 commit into
developfrom
feat/condense-pr-and-comment-guidance
Sep 11, 2026
Merged

docs: Tighten PR-description and comment guidance in AGENTS.md#24329
mydea merged 1 commit into
developfrom
feat/condense-pr-and-comment-guidance

Conversation

@mydea

@mydea mydea commented Sep 11, 2026

Copy link
Copy Markdown
Member

Sharpens two existing agent guidelines that weren't strong enough to change behavior in practice: PR descriptions were coming out too verbose, and code was accumulating comments that only restate what it does.

The PR-description rule now leads with "keep it condensed" and explicitly rules out file-by-file implementation walkthroughs, since the diff already carries that. The comment rule now leads with "default to none" and adds flagging tradeoffs/surprises as the main legitimate reason to comment.

Both edits reinforce intent that was already present rather than introducing new policy.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mydea
mydea requested review from Lms24 and chargome September 11, 2026 07:50
@mydea
mydea marked this pull request as ready for review September 11, 2026 07:50

@Lms24 Lms24 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! 🙏

@mydea
mydea merged commit 7dadc71 into develop Sep 11, 2026
39 checks passed
@mydea
mydea deleted the feat/condense-pr-and-comment-guidance branch September 11, 2026 08:00
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.

2 participants