diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e675b41 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ +# Pull Request Template + +## Description + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. + +Fixes #(issue) + +## Type of Change + +Please delete options that are not relevant. + +- [ ] 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) +- [ ] Documentation update + +## Checklist + +- [ ] My code follows the style guidelines of this project. +- [ ] I have performed a self-review of my code. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] New and existing unit tests pass locally with my changes. +- [ ] I have made corresponding changes to the documentation. + +## Additional Information + +Please provide any additional information or context that would help reviewers understand the change.