diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..ec6d2140 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,48 @@ +# Description + +Please include a summary of the changes and the related issue (if applicable). Please also include relevant motivation and context. List any dependencies that are required for this change. + +Fixes # (issue) + +Additional dependencies intoduced. +- Dependency 1 +- Dependency 2 + +## Type of change + +Please select what type of change this is. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New benchmark + - [ ] Non-breaking change which entirely uses exisiting classes, structure etc + - [ ] Breaking change which has implemented new/modified classes etc +- [ ] New feature + - [ ] Non-breaking change which adds functionality + - [ ] Breaking change fix or feature that would cause existing functionality to not work as expected + +## Other changes + +- [ ] This change requires a documentation update +- [ ] (If Benchmark) This requires additional data that can be obtained from: + - Benchmark data 1 + - Benchamrk data 2 + +# Testing + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration + +- Test A +- Test B +- etc + +# 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 made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] General testing + - [ ] New and existing unit tests pass locally with my changes + - [ ] Coverage is >80% \ No newline at end of file