diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2620d7ec..41564b65 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,33 +1,31 @@ **By submitting this pull request, I confirm the following:** -`{please fill any appropriate checkboxes, e.g: [X]}` +*please fill any appropriate checkboxes, e.g: [X]* -- [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md), as well as this entire template. -- [] I have made only one major change in my proposed changes. -- [] I have commented my proposed changes within the code. -- [] I have tested my proposed changes, and have included unit tests where possible. -- [] I am willing to help maintain this change if there are issues with it later. -- [] I give this submission freely and claim no ownership. -- [] It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1) -- [] I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)) +- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md), as well as this entire template. +- [ ] I have made only one major change in my proposed changes. +- [ ] I have commented my proposed changes within the code. +- [ ] I have tested my proposed changes, and have included unit tests where possible. +- [ ] I am willing to help maintain this change if there are issues with it later. +- [ ] I give this submission freely and claim no ownership. +- [ ] It is compatible with the [EUPL 1.2 license](https://opensource.org/licenses/EUPL-1.1) +- [ ] I have squashed any insignificant commits. ([`git rebase`](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)) -Please make sure you [Sign Off](https://github.com/pi-hole/pi-hole/wiki/How-to-signoff-your-commits.) all commits. Pi-hole enforces the [DCO](https://github.com/pi-hole/pi-hole/wiki/Contributing-to-the-project) +Please make sure you [Sign Off](https://github.com/pi-hole/pi-hole/wiki/How-to-signoff-your-commits.) all commits. Pi-hole enforces the [DCO](https://github.com/pi-hole/pi-hole/wiki/Contributing-to-the-project). --- - **What does this PR aim to accomplish?:** +*A detailed description, screenshots (if necessary), as well as links to any relevant GitHub issues* -`{A detailed description, screenshots (if necessary), as well as links to any relevant GitHub issues}` **How does this PR accomplish the above?:** +*A detailed description (such as a changelog) and screenshots (if necessary) of the implemented fix* -`{A detailed description (such as a changelog) and screenshots (if necessary) of the implemented fix}` **What documentation changes (if any) are needed to support this PR?:** +*A detailed list of any necessary changes* -`{A detailed list of any necessary changes}` -> * `{Please delete this quoted section when opening your pull request}` - -* You must follow the template instructions. Failure to do so will result in your issue being closed. +--- +* You must follow the template instructions. Failure to do so will result in your pull request being closed. * Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time. -* Detail helps us understand an issue quicker, but please ensure it's relevant. +