/pr
Open a pull request on GitHub using the gh CLI and the repo's PR template.
Steps
- Confirm the branch and target:
- Base branch is
main. - Head branch should be a scoped branch such as
feat/*,fix/*,docs/*,ci/*,chore/*, orrefactor/*.
- Base branch is
- Ensure local checks pass first:
Do not open a PR with failing lint/tests.make ci - Push the branch:
git push -u origin HEAD - Create the PR, filling the template
(.github/PULL_REQUEST_TEMPLATE.md):
Then edit the body to complete each section:gh pr create --base main --fill-first- Summary — what changed and why.
- Area — tick the relevant box (architecture / benchmark / use case / docs / DX / CI-build-release).
- Verification — paste the commands you ran (
make ci, manual checks). - Checklist — tick honestly; don't tick boxes you didn't satisfy.
- Notes for Reviewers — anything subtle.
Notes
- Keep the PR scoped to one area. Split unrelated changes.
- If
make ciwas not fully run, say so in Verification rather than implying it passed. - Never retarget a community PR away from
mainunless a maintainer explicitly asks for it.