diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..6ac62798 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,45 @@ + + +## Description + + + +## Motivation and Context + + + + + +- [ ] I have raised an issue to propose this change (required for new features and bug fixes) + +## Types of changes + + + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) +- [ ] Documentation (update in the documentation) + +## Checklist + + + + + + +- [ ] I have updated the changelog accordingly (**required**). +- [ ] My change requires a change to the documentation. +- [ ] I have updated the tests accordingly (_required for a bug fix or a new feature_). +- [ ] I have updated the documentation accordingly. + + +- [ ] I have reformatted the code and checked that formatting passes (**required**). +- [ ] I have have fixed all issues found by `flake8` (**required**). +- [ ] I have ensured that all `pytest` tests pass (**required**). +- [ ] I have run `pytest` on a machine with a CUDA GPU and made sure all tests pass (**required**). +- [ ] I have checked that the documentation builds (**required**). + +Note: We are using a maximum length of 88 characters per line + +