diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d554799 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,34 @@ +## Description + +Please provide a brief summary of the changes in this PR, which include the motivation and context for them, along with any dependencies that are required for these changes. + +Fixes # (issue) + +## Type of Change + +Please delete options that are not relevant and add your own, if necessary. + +- [ ] 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 + +## How Has This Been Tested? + +Please list the xUnit tests you ran to verify your changes. + +- [ ] Test A +- [ ] Test B + +**Test Configuration**: +* Operating System: + +## Checklist: + +- [ ] My pull request is atomic and focuses on a single change. +- [ ] I have added xUnit tests that prove my fix is effective or that my feature works +- [ ] My code follows the C# coding conventions +- [ ] I have commented on my code, particularly in hard-to-understand areas +- [ ] I have documented my changes clearly and comprehensively +- [ ] My changes generate no new warnings +- [ ] Existing unit tests pass locally with my changes