diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..e87bdb4 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,51 @@ +# Related Issue or bug + +Info about Issue or bug + +Closes #[issue number that will be closed through this PR] + +# Describe the changes you've made + +A clear and concise description of what you have done to successfully close your assigned issue. Any new files? or anything you feel to let us know! + +# 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) +- [ ] Code style update (formatting, local variables) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] This change requires a documentation update + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. + +# Describe if there is any unusual behaviour of your code(Write `NA` if there isn't) + +A clear and concise description of it. + +# Checklist: + + +- [ ] My code follows the style guidelines of this project. +- [ ] I have performed a self-review of my own 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. +- [ ] New and existing unit tests pass locally with my changes. +- [ ] Any dependent changes have been merged and published in downstream modules. + +# Screenshots + + Original | Updated + :--------------------: |:--------------------: + **original screenshot** | updated screenshot |