diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..73149bb6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +## Proposed changes + +Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. + +## Fixes + +If it fixes a bug or resolves a feature request, be sure to link to that issue. + +## Types of changes + +What types of changes does your code introduce? (A **breaking change** is a fix or feature that would cause existing functionality and APIs to not work as expected.) +_Put an `x` in the box that applies_ + +- [ ] Non-breaking fix (non-breaking change which fixes an issue) +- [ ] Breaking fix (breaking change which fixes an issue) +- [ ] Non-breaking feature (non-breaking change which adds functionality) +- [ ] Breaking feature (breaking change which adds functionality) +- [ ] Refactor (non-breaking change which changes implementation) +- [ ] Messy (mixture of the above - requires explanation!) + +## Checklist + +_Put an `x` in the boxes that apply._ + +- [ ] I have read the [CONTRIBUTING](../blob/main/CONTRIBUTING.md) doc +- [ ] I am making a pull request against the `main` branch (left side). Also you should start your branch off our `main`. +- [ ] Lint and unit tests pass locally with my changes +- [ ] I have added tests that prove my fix is effective or that my feature works + +## Further comments + +If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc... \ No newline at end of file