Skip to content

Add a PR template with a required "How to verify" section #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
MichaelLeeHobbs wants to merge 1 commit into
base: main
Choose a base branch
from
+29 −0
Draft

Add a PR template with a required "How to verify" section #360

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!--
Thanks for contributing! See CONTRIBUTING.md. Keep this PR to one concern; open large or
sweeping changes as an issue first so scope and a verification plan can be agreed.
-->

## What & why
<!-- What does this change do, and why? -->

Closes #<!-- issue number (required; no PR without a referenced issue) -->

## How to verify
<!--
REQUIRED for any behavior change. Give a reviewer a runnable before/after — not just "tests pass."
Replacing the battery isn't the job; starting the car is.

- Exact steps / input to reproduce.
- Observable result BEFORE this change (the bug) vs AFTER (fixed).
- For behavior a unit test can't capture (wire output, a deployed channel, a REST path),
the exact commands and what you observed.

Docs-only or non-behavioral change? Write "N/A — no behavior change" and why.
-->

## Checklist
- [ ] Scoped to one concern; no drive-by reformatting/renames
- [ ] Tests added/adjusted — a regression test **fails before** the change and **passes after** (line coverage is not proof)
- [ ] `./gradlew build -PdisableSigning=true -Pcoverage=true` passes locally
- [ ] Behavior & compatibility preserved (public API, serialization, DB schema, wire/HL7) — or the change is intentional and called out above
- [ ] No PHI in logs; no new unsafe/reflective deserialization or XXE