diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4b3eac2d433..25627c9f66d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -15,6 +15,16 @@ Please remove this line and the above text before creating your pull request. ### Are there any user-facing changes? +### Checklist + +- [ ] The PR's title follows existing conventions of the repository +- [ ] My code follows the general style and conventions of the codebase +- [ ] I have performed a self-review of these changes +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have added docstrings for any non-trivial APIs I have added +- [ ] I have run `pre-commit run --all` locally and it passed successfully +- [ ] New and existing tests pass locally with my changes + **This PR includes breaking changes to public APIs.** (If there are any breaking changes to public APIs, please explain which changes are breaking. If not, you can remove this.) **This PR contains a "Critical Fix".** (If the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld), please provide explanation. If not, you can remove this.)