Skip to content

docs: add PR/issue/comment instructions for agents#11475

Merged
zkochan merged 2 commits into
mainfrom
agent-updates
May 5, 2026
Merged

docs: add PR/issue/comment instructions for agents#11475
zkochan merged 2 commits into
mainfrom
agent-updates

Conversation

@zkochan

@zkochan zkochan commented May 5, 2026

Copy link
Copy Markdown
Member

Summary

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

Test plan

  • Docs-only change; no tests required.

Written by an agent (Claude Code, claude-opus-4-7).

Summary by CodeRabbit

  • Documentation
    • Added a "Working with GitHub PRs, Issues, and Comments" guide covering keeping PR titles/descriptions current, replying to and resolving review conversations (with resolution details and commit references), and appending agent-authorship footers to agent-authored PRs/issues/comments (including agent name and model).

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.
Copilot AI review requested due to automatic review settings May 5, 2026 19:08
@coderabbitai

coderabbitai Bot commented May 5, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 89389f92-d437-46eb-9803-aeeaf0fe8aa5

📥 Commits

Reviewing files that changed from the base of the PR and between d2de3e4 and ec0ecc2.

📒 Files selected for processing (1)
  • AGENTS.md
✅ Files skipped from review due to trivial changes (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

Added 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).

Changes

Agent Collaboration Guidelines

Layer / File(s) Summary
Documentation Content
AGENTS.md
Inserted new "Working with GitHub PRs, Issues, and Comments" section with three bullet guidelines: keep PR titles/descriptions current; reply to and resolve review conversations with resolution details and commit hash; append agent-authorship footer.
Footer Example
AGENTS.md
Included a markdown example of the agent-authorship footer showing agent name and model signature.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 I hopped through docs with tidy cheer,
I signed my name for all to hear,
PRs refreshed and threads made clear,
A footer hops at end, sincere. 🥕✨

🚥 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 'docs: add PR/issue/comment instructions for agents' directly and clearly summarizes the main change: adding documentation instructions for how agents should handle PRs, issues, and comments.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent-updates

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread AGENTS.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ada28183-d8d1-4c0a-a625-f9aaabf4142e

📥 Commits

Reviewing files that changed from the base of the PR and between e5ec38a and d2de3e4.

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

Comment thread AGENTS.md Outdated
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.
@zkochan zkochan merged commit 286018e into main May 5, 2026
13 checks passed
@zkochan zkochan deleted the agent-updates branch May 5, 2026 19:15
zkochan added a commit that referenced this pull request May 6, 2026
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.
pull Bot pushed a commit to dwongdev/pnpm that referenced this pull request May 14, 2026
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.
github-actions Bot pushed a commit to Eyalm321/pnpm that referenced this pull request May 18, 2026
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.
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