Add a PR template with a required "How to verify" section#360
Draft
MichaelLeeHobbs wants to merge 1 commit into
Draft
Add a PR template with a required "How to verify" section#360MichaelLeeHobbs wants to merge 1 commit into
MichaelLeeHobbs wants to merge 1 commit into
Conversation
The repo has no PR template, and CONTRIBUTING asks a PR only for 'a brief description' while asking bug *reports* for steps-to-reproduce and expected-vs-actual. So a bug report is held to a higher reproducibility bar than the fix for it. This closes that gap: a required How to verify section asking for a reviewer-runnable before/after (and exact steps + observed result for behavior a unit test can't show), plus a short checklist mirroring CONTRIBUTING and the AGENTS.md contributor rules. Reviewers get a way to turn the key instead of trusting green CI.
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
1 participant
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.
What & why
Adds
.github/PULL_REQUEST_TEMPLATE.md— the repo had none. Its centerpiece is a required How to verify section, so a PR ships with a reviewer-runnable before/after instead of just "tests pass." Short checklist mirrors CONTRIBUTING and the AGENTS.md contributor guardrails (one concern, fail-before/pass-after test, the exact local build command, behavior/compat, no PHI/unsafe-deserialization).Closes #359. Origin: @pacmano1's request during review of #343 — the mechanic who replaces the battery but never starts the car. Also closes the gap where CONTRIBUTING asks bug reports for repro + expected-vs-actual but asks PRs only for "a brief description."
How to verify
N/A — no runtime/behavior change; this is a GitHub meta file. To confirm it takes effect:
.github/PULL_REQUEST_TEMPLATE.md.Checklist