diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d6203f561..fdf052135 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,22 +7,42 @@ ### How -### Testing - +--- + +### PR Readiness Checklist + +> The PR readiness bot will validate these automatically after push. +> Check each item before requesting review. See [CONTRIBUTING.md](../CONTRIBUTING.md) for full details. + +#### Branch & Commit +- [ ] Branch created from `dev` (not `main`) +- [ ] Branch is up to date with `dev` (`git fetch upstream && git rebase upstream/dev`) +- [ ] PR is **not** in draft mode (mark ready when checks pass) +- [ ] Commit history is clean (squash fixups before review) + +#### Build & Test - [ ] `npm run build` passes - [ ] `npm test` passes (all tests green) -- [ ] For migration PRs (>20 files): test output summary included below +- [ ] `npm run lint` passes (type check clean) +- [ ] `npm run lint:eslint` passes +- [ ] For migration PRs (>20 files): include test output summary in PR description + +#### Changeset +- [ ] Changeset added via `npx changeset add` (if `packages/squad-sdk/src/` or `packages/squad-cli/src/` changed) +- [ ] Or direct `CHANGELOG.md` entry (maintainers only — write-protected for external contributors) +- [ ] Or `skip-changelog` label applied (if no user-facing changes) -### Docs - -- [ ] CHANGELOG.md entry (if packages/squad-sdk/src/ or packages/squad-cli/src/ changed) +#### Docs + - [ ] README section updated (if new feature/module) - [ ] Docs feature page (if new user-facing capability) -### Exports +#### Exports - [ ] package.json subpath exports updated (if new module) +--- + ### Breaking Changes