diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e7cdd77340..742d35ed7e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,26 +1,31 @@ -**What is this PR about?** -... + + -**Checklist** -+ [ ] Explain important implementation details 👆 -+ [ ] Make sure that [the pre-commit linting/style checks pass](https://docs.pymc.io/en/latest/contributing/python_style.html). -+ [ ] Link relevant issues (preferably in [nice commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)) -+ [ ] Are the changes covered by tests and docstrings? -+ [ ] Fill out the short summary sections 👇 +## Description + -## Major / Breaking Changes -- ... +## Related Issue + + +- [ ] Closes issue: # +- [ ] Related issue (not closed by this PR): # -## New features -- ... +## Checklist + + +- [ ] Checked that [the pre-commit linting/style checks pass](https://docs.pymc.io/en/latest/contributing/python_style.html) +- [ ] Included tests that prove the fix is effective or that the new feature works +- [ ] Added necessary documentation (docstrings and/or example notebooks) +- [ ] If you are a pro: each commit corresponds to a [relevant logical change](https://wiki.openstack.org/wiki/GitCommitMessages#Structural_split_of_changes) + -## Bugfixes -- ... - -## Documentation -- ... - -## Maintenance -- ... +## Type of change + +- [ ] New feature / enhancement +- [ ] Bug fix +- [ ] Documentation +- [ ] Maintenance +- [ ] Other (please specify): +