Skip to content

docs(agents): add PR scope and batching guidance#333

Open
pdmack wants to merge 2 commits into
NVIDIA:mainfrom
pdmack:docs/agents-pr-batching-guidance
Open

docs(agents): add PR scope and batching guidance#333
pdmack wants to merge 2 commits into
NVIDIA:mainfrom
pdmack:docs/agents-pr-batching-guidance

Conversation

@pdmack

@pdmack pdmack commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

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:

  • the root-cause grouping rule
  • a concrete example (broken links, renames, style fixes)
  • a practical heuristic for agents: "would a reviewer naturally review these together?"

For the Reviewer

One file changed: AGENTS.md, 12 lines added after the PR template block.

Issues

Fixes #332

Checklist

  • I am familiar with the Contributing Guidelines.
  • I have signed off my commits for Developer Certificate of Origin (DCO) compliance.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Added guidance for grouping related changes into a single pull request.
    • Included a review-throughput heuristic to help determine when changes should be combined.

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>
@pdmack
pdmack requested a review from a team as a code owner July 21, 2026 22:32
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: e687e8e2-5a81-4a1c-bf76-41c476ab67aa

📥 Commits

Reviewing files that changed from the base of the PR and between f157200 and e874318.

📒 Files selected for processing (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

AGENTS.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.

Changes

Pull Request guidance

Layer / File(s) Summary
PR scope and batching guidance
AGENTS.md
Adds rules for grouping changes with a shared root cause, an example of related file changes, and a reviewer-oriented heuristic for determining PR boundaries.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • NVIDIA/nvcf#290: Updates AGENTS.md with related Pull Request structuring and description guidance.

Suggested reviewers: kristinapathak

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the change: adding PR scope and batching guidance to AGENTS.md.
Linked Issues check ✅ Passed The PR satisfies #332 by adding the section, root-cause grouping rule, example, and reviewer-facing heuristic.
Out of Scope Changes check ✅ Passed The change is tightly scoped to AGENTS.md guidance and does not introduce unrelated code or documentation changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

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.

docs(agents): add PR scope and batching guidance

2 participants