diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..50ef73b65ce --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,36 @@ +## Summary + + +## Related Issue + + +## Changes + + +## Type of Change + +- [ ] Code change (new feature, bug fix, refactor) +- [ ] Code change with doc updates +- [ ] Doc only — prose changes (no code sample modifications) +- [ ] Doc only — includes code sample changes + +## Testing + +- [ ] `make check` passes +- [ ] `npm test` passes +- [ ] `make docs` builds without warnings (for doc changes) + +## Checklist + +### Code changes + +- [ ] `make format` applied (TypeScript and Python) +- [ ] Tests added or updated for new or changed behavior +- [ ] No secrets, API keys, or credentials committed +- [ ] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs) + +### Doc changes + +- [ ] Follows the [style guide](docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR." +- [ ] New pages include SPDX license header and frontmatter (if creating a new page) +- [ ] Cross-references and links verified