diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..77cce647 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,87 @@ + + +## Summary + + + +Resolves: + +## Design decisions + + + +## Scope + + + +## Test plan + + + +- [ ] +- [ ] + +## Risk note + + + +## Coverage note + + + +## Author checklist + +Before moving this PR from Draft to Ready for Review: + +- [ ] Linked to a Linear ticket or GitHub issue (above) +- [ ] I understand every change in the diff — not "an agent wrote it, I'm not sure why" +- [ ] Runs locally, exercised through the end-user path (not just unit tests) +- [ ] `make check` and `make test` are green locally; CI is expected to pass +- [ ] I've pulled the branch fresh and reviewed my own diff top-to-bottom +- [ ] I'd merge it myself if a teammate said LGTM right now diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ddf4300b..70cd51f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,6 +129,10 @@ git push origin name-of-your-bugfix-or-feature # Pull Request Guidelines +When you open a pull request, the [PR template](.github/PULL_REQUEST_TEMPLATE.md) will populate the description with prompts for a summary, ticket link, test plan, and a self-review checklist. Fill it in — it's the bar for moving from Draft to Ready for Review. + +In short: PRs should be small and focused, tested through the end-user path (not just unit tests), and self-reviewed before you mark them Ready. The reviewer is your customer — craft the PR so they can read, understand, and approve it on the first pass. + Before you submit a pull request, check that it meets these guidelines: 1. The pull request should include tests.