diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..f8fd00e1 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,50 @@ +> ℹ️ Describe the big picture of your changes here to communicate to the maintainers +why we should accept this pull request. If it fixes a bug or resolves a feature +request, be sure to link to that issue. + +### `Type` +--- + +> ℹ️ What types of changes does your code introduce? + +> _Put an `x` in the boxes that apply_ + +- [ ] Fix +- [ ] Perf +- [ ] Docs +- [ ] Test +- [ ] Chore +- [ ] Feature +- [ ] Refactor + +### `SemVer` +--- + +> ℹ️ What changes to the current `semver` range does your PR introduce? + +> _Put an `x` in the boxes that apply_ + +- [ ] Bug (:label: Patch) +- [ ] Feature (:label: Minor) +- [ ] Breaking Change (:label: Major) + +### `Issues` +--- + +> ℹ️ What issue (if any) are closed by your PR? + +> _Replace `#1` with the error number that applies_ + +- Fixes `#1` + +### `Checklist` +--- + +> ℹ️ You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. This is a reminder of what we are going to look for before merging your code. + +> _Put an `x` in the boxes that apply._ + +- [ ] Lint and unit tests pass with my changes +- [ ] I have added tests that prove my fix is effective/works +- [ ] I have added necessary documentation (if appropriate) +- [ ] Any dependent changes are merged and published in downstream modules