diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0a6b228 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,39 @@ +# Pull Request + +## Description + +Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. + +Fixes # (issue number) + +## Type of change + +Please delete options that are not relevant. + +- [ ] New Ressource +- [ ] New Module +- [ ] Content fix +- [ ] Documentation update +- [ ] 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) + + +## How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. + +- [ ] Code Review +- [ ] Local execution +- [ ] other (please specify) + +## Checklist: + +- [ ] My content is Open Source (see License) +- [ ] My code follows the Open Source 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 where needed +- [ ] My changes generate no new warnings (double check during this pull request) +- [ ] I have added tests that prove my fix is effective or that my feature works (described above) +- [ ] Any dependent changes have been merged and published in downstream branches (development first)