diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..2604461 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +# Pull Request Template + +## Description + +Please include a summary of the change and which issue is fixed. If this does not fix an issue, then first create a new issue. Please also include relevant motivation and context. + +Fixes # (issue) + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Include an example pdf if you have one. + +## Checklist: + +- [ ] I have optimized the code at least one time after creating the initial version +- [ ] I have added docstrings to newly created methods and classes +- [ ] I have updated the README.md and other documentation, or I am sure that this is not necessary +- [ ] I have added tests that prove my fix is effective or that my feature works