diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 0000000..c6b666c --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,25 @@ +# Description + +Please include a summary of the changes and link the related github issue. +Please include relevant motivation and context. + +Fixes # (Issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] Minor change (non-breaking change, e.g. documentation adaption) +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that causes existing functionality to not work as expected) + +# Checklist: +- [ ] 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 or my feature works +- [ ] New and existing tests pass locally with my changes +- [ ] My changes contain no console logs +