diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..d8acb5e --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +# Description + +Please include a summary of the changes along with any relevant motivation and context. + + + +- Closes # +- Fixes # +- Resolves # + +## Type of change + + + +- [ ] 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 not work as expected) +- [ ] Packaging (updates the packaging) +- [ ] Documentation (updates the documentation) + +# Checklist: + +- [ ] I have performed a self-review of my code +- [ ] I have tested my code in common scenarios and confirmed there are no regressions +- [ ] I have added comments to my code, particularly in hard-to-understand sections +- [ ] I have made corresponding changes to the documentation (*remove if no documentation changes were required*)