Skip to content

Make pull request template more compact #4

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

Open
ahelmberger wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Make pull request template more compact #4

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
42 changes: 4 additions & 38 deletions PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,47 +1,13 @@
## What
## Description

{1–2 sentences. What this PR does in plain language. Not a code-walkthrough — focus on the user-visible or system-visible change.}
{What this PR does in plain language and, if non-obvious, why this change is needed. Not a code-walkthrough — focus on the user-visible or system-visible change}

## Why

{Why this change is needed. Reference the ticket and pull in the key constraint or context that drove the approach. If a non-obvious decision was made, name it.}

Closes ENG-123
Closes {https://put.the/ticket-link/here}

## How to verify

{Step-by-step instructions a reviewer can follow locally. Be specific: env vars to set, routes to hit, fixtures to use, expected output. If there's no manual verification path (pure refactor, infra), say so explicitly and point to the automated tests.}

1. ...
2. ...
3. ...
{Instructions a reviewer can follow locally. If there's no manual verification path, say so explicitly and point to the automated tests.}

## Notes for the reviewer

{Optional. Call out anything unusual: a deliberate deviation from a pattern, a follow-up that's deferred, a known limitation. Skip this section if there's nothing to flag.}

---

## Ready to merge

🧠 **Go through each point yourself. Do not treat these as formalities.**

**Author**

- Tested the feature end-to-end as a user would, including edge cases and failure states
- Automated tests cover the happy path, edge cases, and failure states where applicable
- Implementation matches the ticket: acceptance criteria, scope, and out of scope
- Regression risk was considered and tested where applicable

**What did you test? List the cases briefly**

1. ...
2. ...
3. ...

**Reviewer**

- Pulled and ran the branch locally for any UI or user-facing changes
- Tested the feature yourself, independently from the author's description
- Verified behavior against the acceptance criteria, not just the code diff
- Regression risk was independently assessed