docs: add pull-request template with Motivation / Behavior / Test plan - #1856
Open
jacalata wants to merge 1 commit into
Open
docs: add pull-request template with Motivation / Behavior / Test plan#1856jacalata wants to merge 1 commit into
jacalata wants to merge 1 commit into
Conversation
Reviewers of PRs to this repo have to guess "why now" for most changes, whether a PR is a behavior change for downstream users, and which claims in the body are covered by tests vs. verified manually. Adding a template with three prompts lets contributors surface those answers without me nagging in every review. The sections are opinionated but small: Motivation, Behavior change, and Test plan. Each has a comment explaining the intent. Contributors can delete sections that don't apply. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Motivation
Multiple recent reviews on this repo have surfaced the same three
questions across unrelated PRs: "why now?", "does anything change for
downstream users?", and "which claims in the body are covered by tests
vs. verified manually?" Answering them once per PR beats being asked
each time.
Behavior change
None -- adds
.github/PULL_REQUEST_TEMPLATE.md. GitHub picks this upautomatically when opening a new PR against the repo.
Test plan
None -- docs-only.
🤖 Generated with Claude Code