Skip to content

docs: tell agents to fill in the PR template - #1426

Merged
inimaz merged 2 commits into
masterfrom
docs/agent-pr-template
Sep 23, 2026
Merged

inimaz merged 2 commits into
masterfrom
docs/agent-pr-template

Conversation

@davidberenstein1957

Copy link
Copy Markdown
Collaborator

Description

Adds an "Opening Pull Requests" section to docs/how-to/agent-instructions.md. It tells coding agents to fill in every section of .github/PULL_REQUEST_TEMPLATE.md and pass it with gh pr create --body-file, because a plain --body skips the template. It also says the AI Usage Disclosure choice belongs to the human contributor.

Related Issue

N/A. This follows a review comment asking that PRs opened with Claude Code follow the template.

Motivation and Context

My recent PRs were opened by Claude Code with gh pr create --body, which bypasses the template, so none of them followed it. The comment suggested docs/how-to/agents.md, but that page is the tutorial on tracking LLM inference emissions. The file agents actually read is agent-instructions.md: CLAUDE.md, AGENTS.md and .github/copilot-instructions.md all symlink to it. This PR itself was opened following the new instruction.

How Has This Been Tested?

Docs-only change of four lines. I checked that the symlinks resolve to the edited file (ls -l CLAUDE.md AGENTS.md .github/copilot-instructions.md).

Screenshots (if appropriate):

N/A

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Docs only.

AI Usage Disclosure

Please refer to docs/how-to/ai-policy.md for detailed guidelines on how to disclose AI usage in your PR. Accurately completing this section is mandatory.

  • 🟥 AI-vibecoded: You cannot explain the logic. Car analogy : the car drive by itself, you are outside it and just tell it where to go.
  • 🟠 AI-generated: Car analogy : the car drive by itself, you are inside and give instructions.
  • ⭐ AI-assisted. Car analogy : you drive the car, AI help you find your way.
  • ♻️ No AI used. Car analogy : you drive the car.

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the docs/how-to/contributing.md document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@davidberenstein1957
davidberenstein1957 requested a review from a team as a code owner September 23, 2026 08:46

@inimaz inimaz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@inimaz
inimaz enabled auto-merge (squash) September 23, 2026 17:00
@inimaz
inimaz merged commit b64423c into master Sep 23, 2026
6 checks passed
@inimaz
inimaz deleted the docs/agent-pr-template branch September 23, 2026 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants