docs(agents): add PR scope and batching guidance#333
Open
pdmack wants to merge 2 commits into
Open
Conversation
Agents tend to open one PR per file even when multiple files share a
root cause, which creates reviewer fatigue and clutters project history.
Add a short section to AGENTS.md explaining that changes with the same
root cause belong in one PR, with a concrete example and a heuristic
("would a reviewer naturally review these together?").
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAGENTS.md adds “PR scope and batching” guidance covering root-cause grouping, a concrete example, and a heuristic for deciding whether changes should be combined or split. ChangesPull Request guidance
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
sbaum1994
approved these changes
Jul 21, 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.
TL;DR
Add a "PR scope and batching" section to AGENTS.md to guide agents (and humans) to group changes with the same root cause into one PR instead of one PR per file.
Additional Details
Agents tend to open one PR per file even when multiple files share a root cause. This creates reviewer fatigue, clutters project history, and forces maintainers to approve the same logical change multiple times.
Observed concretely: PRs #240, #241, #242, #261 each fixed one or two files but all addressed the same root cause (broken links from the GitLab-to-GitHub migration). They could have been one PR.
The new section sits after the existing PR description template in AGENTS.md and covers:
For the Reviewer
One file changed:
AGENTS.md, 12 lines added after the PR template block.Issues
Fixes #332
Checklist
Summary by CodeRabbit