diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..9efebb3 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,39 @@ +Provide a general summary of your changes in the title above. You should +remove this overview, any sections and any section descriptions you +don't need below before submitting. There isn't a strict requirement to +use this template if you can structure your description and still cover +these points. + +## Description + +Describe your changes in detail through motivation and context. Why is +this change required? What problem does it solve? If it fixes an open +issue, link to the issue using GitHub's closing issues keywords[1]. + +## Has your change been tested? + +Explain how the change has been tested and what you ran to confirm your +change affects other parts of the code. Automated tests are generally +expected and changes without tests should explain why they aren't +required. + +## Screenshots (if appropriate): + +## Types of changes + +What sort of change does your code introduce/modify? + +- [ ] 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) + +## Checklist: + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. +- [ ] This change is using publicly documented and stable APIs. + +[1]: https://help.github.com/articles/closing-issues-using-keywords/