Skip to content

docs(agents): add PR review response guidance to AGENTS.md#2850

Merged
mnriem merged 3 commits into
github:mainfrom
mnriem:docs/2849-pr-review-response-guidance
Jun 4, 2026
Merged

docs(agents): add PR review response guidance to AGENTS.md#2850
mnriem merged 3 commits into
github:mainfrom
mnriem:docs/2849-pr-review-response-guidance

Conversation

@mnriem
Copy link
Copy Markdown
Collaborator

@mnriem mnriem commented Jun 4, 2026

Closes #2849.

Summary

Adds a short "Responding to PR Review Comments" section to AGENTS.md (between "Branch Naming Convention" and "Common Pitfalls") so agents acting on PRs in this repo stop posting one reply per review comment.

Background

Recent PR review cycles have produced large numbers of agent-authored reply comments — one per reviewer finding, each starting with a "Fixed in <sha>" status header that mirrors the reviewer's items 1:1. #2704 is the visible example: the latest Copilot review there generated 9 inline comments, and the author posted 9 near-identical replies in a row. That floods the conversation, buries the diff, and is visibly not how a human maintainer would respond.

AGENTS.md had no guidance on this, so agents fell back to default per-comment-reply behavior.

The new section

Six directive bullets, kept terse on purpose:

  • Agent self-disclosure (name the agent, model, and the human being acted for)
  • One top-level summary comment per review round
  • Inline replies only when context is needed (disagreement, deferral, non-obvious fix)
  • Never click "Resolve conversation" — that belongs to the reviewer or PR author
  • No emoji, no celebratory framing, no checklist mirroring the reviewer's items, no restating what the reviewer wrote
  • Re-request review once per round, not after every intermediate push

Out of scope

  • Doesn't change .github/copilot-instructions.md or any agent-specific instruction file. If maintainers want this enforced on the Copilot coding-agent path specifically, that can be a follow-up.
  • Doesn't add automated enforcement (e.g., a PR check). This is documentation-only behavioral guidance.

…ding

Adds a 'Responding to PR Review Comments' section to AGENTS.md so agents
acting on PRs stop posting one reply per review comment. Directs them to
post one summary comment per review round, disclose their identity and
the human they're acting for, never click 'Resolve conversation', and
re-request review once per round rather than after every push.

Closes github#2849
Copilot AI review requested due to automatic review settings June 4, 2026 13:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds documentation guidance to reduce noisy agent behavior in PR review threads by standardizing how agents should respond to review feedback in this repository.

Changes:

  • Adds a new “Responding to PR Review Comments” section to AGENTS.md.
  • Provides concise directives encouraging a single top-level summary response per review round and limiting inline replies to cases where context is necessary.
Show a summary per file
File Description
AGENTS.md Adds PR review response guidance to prevent agent comment flooding and improve review thread readability.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1

Comment thread AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 4, 2026 13:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 1

Comment thread AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 4, 2026 13:47
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 0 new

@mnriem mnriem merged commit 829740e into github:main Jun 4, 2026
11 checks passed
@mnriem mnriem deleted the docs/2849-pr-review-response-guidance branch June 4, 2026 13:53
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 review response guidance to AGENTS.md to prevent agent comment flooding

2 participants