Skip to content
IonWarpGet started
Pull request checklist

Pull request checklist and a GitHub PR template

Before you ask for review, check six things: one small change, a description that says what and why, a test that fails without the change, every file that changes with it, no secrets, and docs that still match.

Example pull request#310

What lands on your pull request · Code Review

P1Retry charges the same order twice
billing/checkout.ts:42 · A timed-out response can charge the order twice
- await payments.charge(order);+ await payments.charge(order, {+   idempotencyKey: order.id,+ });
When payment succeeds but the response times out, the caller retries the same order. Both calls charge it. Pass the stable order ID as the payment idempotency key.

The fourth matters most. When two AI readers graded 267 IonWarp findings, nearly all from 24 to 29 September 2026, 12 of the 17 real merge blockers were a pull request that changed one thing and missed a test, a migration list, a config value or a second read path that had to change with it.

Pull request checklist

  • 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. When one change builds on another, stacked pull requests keep each one small.

  • A description that says what and why

    What changes, why, and how to check it. Write Closes #123 to link the issue, and GitHub closes it when the pull request merges into the default branch.[1]

  • A test that fails without the change

    If you are not sure it does, run it once against the old code.

  • 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 ReviewOn Starter, Pro and Max

  • No secrets in code or logs

    No token, key or password in the code, a log line, an error message or the client bundle.

    Security ReviewOn Starter, Pro and Max

  • Docs that still match

    The README, comments and agent instructions such as CLAUDE.md or AGENTS.md that this change made wrong.

    Docs ReviewOn Pro and Max

A pull request template to copy

## 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
  1. Where to save it

    Save it as .github/pull_request_template.md. GitHub fills each new pull request with it once it is on the default branch.[2] A CODEOWNERS file in the same folder requests a review from each path owner automatically.

Pricing

Simple pricing for your whole team.

One workspace price with seats included. Credits pool across your team. Unlimited repos on every plan.

Starter

$0 /mo

Try AI PR review.

  • 2 reviewers
    • Code Review
    • Security Review
  • 3 seats included
  • 15,000 credits to start, then 5,000/mo
  • About 70 reviews to start, then about 25 a month
  • Unlimited repos
Get Started

Max

$149 /mo

Scale AI PR review.

  • +9 reviewers
    • UX Review
    • API Performance
    • Analytics Review
    • SEO Review
    • Changelog
    • CI/CD Performance
    • Plan Review
    • Repeat-Failure Learnings
    • SOC 2 Review
  • 10 seats included
  • +75,000 credits/mo
  • About 360 reviews a month
  • +$29/mo per added seat
  • Unlimited repos
  • Priority support
Choose Max
Enterprise

Custom reviewers + credits · GitHub Enterprise · SSO/SAML + audit logs · Custom security review + SLA

Contact us
FAQ

Frequently asked questions

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. For several templates, add a PULL_REQUEST_TEMPLATE folder and pick one with the template query parameter. Templates apply once they are merged into the default branch.

What should a pull request description include?

What changes, why, how to test it, and what could break. Link the issue it closes, and add screenshots for anything a user can see.

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. Our guide What is code review? lists it.

Sources

  1. Linking a pull request to an issueGitHub Docs · read
  2. Creating a pull request template for your repositoryGitHub Docs · read