docs: add PR/issue/comment instructions for agents#11475
Conversation
Add a "Working with GitHub PRs, Issues, and Comments" section to AGENTS.md covering: keeping PR title/description in sync after pushes, replying with the resolution and commit hash and closing resolved review threads, and signing all agent-authored content with a footer naming the agent and model.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdded a documentation section to AGENTS.md titled "Working with GitHub PRs, Issues, and Comments" with guidelines for keeping PR metadata current, resolving review conversations with resolution details and commit hashes, and appending an agent-authorship footer (agent name and model). ChangesAgent Collaboration Guidelines
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing guidance to AGENTS.md for how automation/agents should manage GitHub PR metadata and review communication, plus a required signature footer for agent-authored GitHub content.
Changes:
- Document keeping PR titles/descriptions up-to-date as changes are pushed.
- Document replying to addressed review threads with the resolution + commit hash and then resolving the conversation.
- Document a required footer signature for agent-authored comments/issues/PRs including agent name + model name (with an example).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Around line 198-201: The fenced code block containing the YAML-like snippet
("---\nWritten by an agent (Claude Code, claude-opus-4-7).") must include a
language specifier; change the opening fence from ``` to ```markdown so the
block is labeled and satisfies markdownlint and rendering expectations.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Address review feedback on AGENTS.md: - Reword "Answer and close resolved review comments" to "Reply to and resolve review conversations" to avoid the contradictory phrasing (a resolved thread is already closed). - Add the `markdown` language specifier to the agent-footer fenced block so it satisfies markdownlint MD040.
Add a "Working with GitHub PRs, Issues, and Comments" section to AGENTS.md covering three rules: Keep PR title and description current when pushing new changes. Reply to resolved review comments with the resolution + commit hash and close the conversation. Sign all agent-authored comments, issues, and PRs with a footer that names the agent and model.
Mirror the new "Working with GitHub PRs, Issues, and Comments" section landed upstream in pnpm/pnpm AGENTS.md (PR pnpm#11475): keep PR title and description current after pushes, reply to and resolve review conversations with the resolution + commit hash, and sign all agent-authored GitHub content with a footer naming the agent and model.
Mirror the new "Working with GitHub PRs, Issues, and Comments" section landed upstream in pnpm/pnpm AGENTS.md (PR pnpm#11475): keep PR title and description current after pushes, reply to and resolve review conversations with the resolution + commit hash, and sign all agent-authored GitHub content with a footer naming the agent and model.
Summary
AGENTS.mdcovering three rules:Test plan
Written by an agent (Claude Code, claude-opus-4-7).
Summary by CodeRabbit