docs: tell agents to fill in the PR template - #1426
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
inimaz
approved these changes
Sep 23, 2026
inimaz
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @davidberenstein1957 !
inimaz
enabled auto-merge (squash)
September 23, 2026 17:00
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdand pass it withgh pr create --body-file, because a plain--bodyskips 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 suggesteddocs/how-to/agents.md, but that page is the tutorial on tracking LLM inference emissions. The file agents actually read isagent-instructions.md:CLAUDE.md,AGENTS.mdand.github/copilot-instructions.mdall 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
xin all the boxes that apply: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.
Checklist:
Go over all the following points, and put an
xin all the boxes that apply.🤖 Generated with Claude Code