Checklist
The pull request checklist
Check these before you ask for review. The one people miss most is the fourth: when we graded 267 IonWarp findings from late September 2026, 12 of the 17 real merge blockers were a pull request that changed one thing and missed a test, a migration, a config value or a second read path that had to change with it.
The nine checks
- 01
One change, small enough to read
Split a refactor from a behavior change, and a rename from both. A short diff gets read line by line; a long one gets skimmed.
- 02
A description that says what and why
What changes, why, and how to check it. Write
Closes #123to link the issue; GitHub closes it when the pull request merges into the default branch.[1] - 03
A test that fails without the change
If you are not sure it does, run it once against the old code.
Code Review checks this - 04
Everything that changes with it
Search for the callers of anything you renamed, removed or retyped, and for the tests, migrations, configs and docs that name it.
Code Review checks this - 05
No secrets, no missing checks
No token, key or password in code, a log line, an error message or the client bundle; no route that skips its permission check.
Security Review checks this - 06
Errors that still reach you
No empty catch, no promise left unhandled, and a log line with the request id where something can fail.
Log & Errors checks this - 07
No query in a loop
Lists load their related rows in one query, and every list read has a limit.
API Performance checks this - 08
Docs that still match
The README, comments and agent instructions (CLAUDE.md, AGENTS.md) this change made wrong.
Docs Review checks this - 09
CI still fast and still strict
Workflow edits keep the cache key on the lockfile, keep heavy jobs behind path filters, and keep required checks required.
CI/CD Performance checks this
Template
A pull request template to copy
Save it as .github/pull_request_template.md. GitHub fills every new pull request with it once it is on the default branch.[2]
## Summary
<!-- What this changes, in one or two sentences. Closes #123 -->
## Why
<!-- The problem or decision behind the change. -->
## How to test
<!-- The command to run or the steps to click, and what the reviewer should see. -->
## Risk and rollback
<!-- What could break, who it affects, and how to undo it. -->
## Screenshots
<!-- Before and after, for any change a user can see. -->
## Checklist
- [ ] A test covers the change
- [ ] Callers of anything renamed, removed or retyped are updated
- [ ] Docs that this change made wrong are updated
- [ ] No secrets in code, logs or the client bundle
- [ ] No new query inside a loop on a request path
- [ ] CI workflow changes keep the cache and the required checksAutomate it
Let the fleet run the checklist
7 of the 9 checks are what IonWarp’s agents look for on every pull request, before a person opens it. You keep the first two: only you know what the change is for.
What should a pull request checklist include?
One small change, a description with what and why, a test that fails without the change, every caller and file that changes with it, no secrets, and docs that still match. The list above adds errors, queries and CI.
Where do I put a pull request template on GitHub?
Name it pull_request_template.md and put it in the repository root, the docs folder or the .github folder. GitHub uses it once it is on the default branch.
How do I link a pull request to an issue?
Write Closes #123 in the description, or Fixes or Resolves. GitHub closes the issue when the pull request merges into the default branch.
Is a pull request checklist the same as a code review checklist?
No. The pull request checklist is the author’s, done before asking for review. The code review checklist is the reviewer’s: correctness, what the change breaks elsewhere, security and design.
Sources
- GitHub Docs, Linking a pull request to an issue, read 2026-10-03.
- GitHub Docs, Creating a pull request template for your repository, read 2026-10-03.
Ship the checklist with every PR.
Try for free14 days free, no card. Then Pro is $49 a month per workspace with 5 seats, or Max $149 with 10.