diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..11693899 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,30 @@ +# Description + +Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change. + +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) +- [ ] CleanCode (Code refactor, test updates, does not introduce functional changes) +- [ ] Documentation update (Doc only change) + +## How Has This Been Tested? + +> **_NOTE:_** All functional changes should accompany corresponding tests (unit tests, functional tests etc). + +Please describe the addition/modification of tests done to verify this change. Please also list any relevant details for your test configuration. + +## Contributor's Checklist + +Please check that you have: + +- [ ] self-reviewed the code in this PR. +- [ ] added code comments, particularly in hard-to-understand areas. +- [ ] updated the user documentation with corresponding changes. +- [ ] added tests to verify effectiveness of this change.