diff --git a/pull_request_template.md b/pull_request_template.md new file mode 100644 index 000000000..9cb30e4ba --- /dev/null +++ b/pull_request_template.md @@ -0,0 +1,28 @@ +# Description + +Please include a summary of the changes and the related issue (Why is this change necessary). 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) +- [ ] This change requires a documentation update + +# Testing + +Attach images and describe testing done to validate functionality. + +* Clients tested: + +# Checklist: + +- [ ] I have performed a self-review of my code. Ensuring variables, functions and methods are named in a human-readable way, comments are added only where naming of variables, functions and methods can't give enough context. +- [ ] I have tested my changes +- [ ] I have made corresponding changes to the documentation +- [ ] I own the changes of my code take responsibilities for the potential issues that occur +