From d9077310278a31766cdcff744b30a4fd388fc0b4 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 20 Sep 2016 15:10:34 -0500 Subject: [PATCH 1/6] new template based on udemy-dl --- .github/ISSUE_TEMPLATE.md | 41 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 38 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 04303614..473d1828 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,7 +1,42 @@ -##### Expected Behaviour: +_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._ +**In raising this issue, I confirm the following (please check boxes, eg [X]):** -##### Actual Behaviour: +- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md). +- [ ] I have verified that the issue I am reporting can be replicated, or that the [feature](https://pi-hole.net/feature-requests/) I am suggesting [isn't already acknowledged](https://github.com/pi-hole/pi-hole/wiki). +- [ ] I have checked that the issue I'm reporting isn't already solved and no duplicates exist in [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) and in [opened issues](https://github.com/pi-hole/pi-hole/issues) +- [ ] I have checked the [pull requests tab](https://github.com/pi-hole/pi-hole/pulls) for existing solutions/implementations to my issue/suggestion. +- [ ] I have prefixed my issue title with one of the following: _[BUG], [ISSUE], [FEATURE REQUEST], [QUESTION], [OTHER]_. +**My familiarity with the project is as follows (check one, eg [X]):** -##### Steps to reproduce this issue: +- [ ] I have never used the project. +- [ ] I have used the project briefly. +- [ ] I have used the project extensively, but have not contributed previously. +- [ ] I am an active contributor to the project. + +--- +**(Optional) Debug Log generated by `pihole -d`:** + +`http://termbin.com/` + +**[BUG | ISSUE] Expected Behaviour:** + +_{replace this section with your content or delete if not a BUG/ISSUE}_ + +**[BUG | ISSUE] Actual Behaviour:** + +_{replace this section with your content or delete if not a BUG/ISSUE}_ + +**[BUG | ISSUE] Steps to reproduce:** + +_{replace this section with your content or delete if not a BUG/ISSUE}_ + +- +- +- +- + +**[FEATURE REQUEST | QUESTION | OTHER]:** + +_{replace this line with your content or delete if not a FEATURE REQUEST/QUESTION/OTHER}_ From fcb7d9111eeffb7b663a4cbaf100a0eda3fa5af3 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 20 Sep 2016 15:14:15 -0500 Subject: [PATCH 2/6] new template based on udemy-dl --- .github/PULL_REQUEST_TEMPLATE.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b289a1c0..af052392 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,19 @@ -Fixes #[issue number] . +_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._ -Changes proposed in this pull request: +**By submitting this pull request, I confirm the following (please check boxes, eg [X]):** -- +- [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md). +- [ ] I have checked that [another pull request](https://github.com/pi-hole/pi-hole/pulls) for this purpose does not exist. +- [ ] I have considered, and confirmed that this submission will be valuable to others. +- [ ] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. +- [ ] I give this submission freely, and claim no ownership to its content. -- +**My familiarity with the project is as follows (check one, eg [X]):** -- +- [ ] I have never used the project. +- [ ] I have used the project briefly. +- [ ] I have used the project extensively, but have not contributed previously. +- [ ] I am an active contributor to the project. -@pi-hole/gravity +--- +_{replace this line with your pull request content}_ From e6a37588996a0d22f81fc8a87fe726c09a5de082 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 20 Sep 2016 15:29:20 -0500 Subject: [PATCH 3/6] new template based on udemy-dl --- CONTRIBUTING.md | 43 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1313f599..539f55d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,37 @@ -This is a basic checklist for now, We will update it in the future. +_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._ -* Fork the repo and create your new branch based on the `development` branch. -* Commit Unix line endings -* If you want, try to keep to the theme of black holes/gravity. This can add some fun to your submission. -* Submit Pull Requests to the development branch only. -* Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!) -* Be patient. We will review all submitted pull requests, but our focus is on stability.. please don't be offended if we reject your PR, or it appears we're doing nothing with it! We'll get around to it.. +# Contributors Guide + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +- Our goal for Pi-hole is **stability before features**. This means we focus on squashing critical bugs before adding new features. Often, we can do both in tandem, but bugs will take priority over a new feature. +- Pi-hole is open source and [powered by donations](https://pi-hole.net/donate/), and as such, we give our **free time** to build, maintain, and **provide user support** for this project. It would be extremely unfair for us to suffer abuse or anger for our hard work, so please take a moment to consider that. +- Please be considerate towards the developers and other users when raising issues or presenting pull requests. +- Respect our decision(s), and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many people, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project. + +## Procedure + +**Before filing an issue:** + +- Attempt to replicate and **document** the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +**Before submitting a pull request:** + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Technical Requirements + +- Submit Pull Requests to the **development branch only**. +- Before Submitting your Pull Request, merge `development` with your new branch and fix any conflicts. (Make sure you don't break anything in development!) +- Commit Unix line endings. +- (Optional fun) keep to the theme of Star Trek/black holes/gravity. From 4a0d5138a11c42d0c4fc21a784b1602994302b3b Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 20 Sep 2016 15:30:27 -0500 Subject: [PATCH 4/6] move CONTRIBUTING.MD to .github --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md From 34806ee2c22947a3f3d75c6e6db59ece9ec28136 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Wed, 21 Sep 2016 08:39:32 -0500 Subject: [PATCH 5/6] 1-10 codebase familiarity Also tried to simplify the language a bit so as not to deter people from submitting issues. We may need to simplify it more --- .github/ISSUE_TEMPLATE.md | 20 +++++++++++++------- .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++----- 2 files changed, 24 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 473d1828..2cda41c2 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,17 +3,23 @@ _This template was created based on the work of [`udemy-dl`](https://github.com/ **In raising this issue, I confirm the following (please check boxes, eg [X]):** - [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md). -- [ ] I have verified that the issue I am reporting can be replicated, or that the [feature](https://pi-hole.net/feature-requests/) I am suggesting [isn't already acknowledged](https://github.com/pi-hole/pi-hole/wiki). -- [ ] I have checked that the issue I'm reporting isn't already solved and no duplicates exist in [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) and in [opened issues](https://github.com/pi-hole/pi-hole/issues) +- [ ] I have verified that the issue I am reporting can be replicated +- [ ] I have checked that the issue I'm reporting isn't a duplicate in our [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), or [open issues](https://github.com/pi-hole/pi-hole/issues). - [ ] I have checked the [pull requests tab](https://github.com/pi-hole/pi-hole/pulls) for existing solutions/implementations to my issue/suggestion. - [ ] I have prefixed my issue title with one of the following: _[BUG], [ISSUE], [FEATURE REQUEST], [QUESTION], [OTHER]_. -**My familiarity with the project is as follows (check one, eg [X]):** +**How familiar are you with the codebase?:** -- [ ] I have never used the project. -- [ ] I have used the project briefly. -- [ ] I have used the project extensively, but have not contributed previously. -- [ ] I am an active contributor to the project. +- [ ] 1 (very unfamiliar) +- [ ] 2 +- [ ] 3 +- [ ] 4 +- [ ] 5 +- [ ] 6 +- [ ] 7 +- [ ] 8 +- [ ] 9 +- [ ] 10 (very familiar) --- **(Optional) Debug Log generated by `pihole -d`:** diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index af052392..3eb26862 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,12 +8,18 @@ _This template was created based on the work of [`udemy-dl`](https://github.com/ - [ ] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. - [ ] I give this submission freely, and claim no ownership to its content. -**My familiarity with the project is as follows (check one, eg [X]):** +**How familiar are you with the codebase?:** -- [ ] I have never used the project. -- [ ] I have used the project briefly. -- [ ] I have used the project extensively, but have not contributed previously. -- [ ] I am an active contributor to the project. +- [ ] 1 (very unfamiliar) +- [ ] 2 +- [ ] 3 +- [ ] 4 +- [ ] 5 +- [ ] 6 +- [ ] 7 +- [ ] 8 +- [ ] 9 +- [ ] 10 (very familiar) --- _{replace this line with your pull request content}_ From 6f6450bcff058231d61e962a6b89bb37b7760e18 Mon Sep 17 00:00:00 2001 From: Jacob Salmela Date: Tue, 27 Sep 2016 08:23:52 -0500 Subject: [PATCH 6/6] simplify a bit more Removed a few checkboxes. I really don't want to deter people from submitting issue because of a wall of text, but some of this information we really can use to be more helpful. --- .github/ISSUE_TEMPLATE.md | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 2cda41c2..fc2d528e 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,10 +3,8 @@ _This template was created based on the work of [`udemy-dl`](https://github.com/ **In raising this issue, I confirm the following (please check boxes, eg [X]):** - [ ] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md). -- [ ] I have verified that the issue I am reporting can be replicated -- [ ] I have checked that the issue I'm reporting isn't a duplicate in our [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), or [open issues](https://github.com/pi-hole/pi-hole/issues). -- [ ] I have checked the [pull requests tab](https://github.com/pi-hole/pi-hole/pulls) for existing solutions/implementations to my issue/suggestion. -- [ ] I have prefixed my issue title with one of the following: _[BUG], [ISSUE], [FEATURE REQUEST], [QUESTION], [OTHER]_. +- [ ] The issue I am reporting can be *replicated* +- [ ] The issue I'm reporting isn't a duplicate (see [FAQs](https://github.com/pi-hole/pi-hole/wiki/FAQs), [closed issues](https://github.com/pi-hole/pi-hole/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), and [open issues](https://github.com/pi-hole/pi-hole/issues)). **How familiar are you with the codebase?:** @@ -22,27 +20,23 @@ _This template was created based on the work of [`udemy-dl`](https://github.com/ - [ ] 10 (very familiar) --- -**(Optional) Debug Log generated by `pihole -d`:** +**[FEATURE REQUEST | QUESTION | OTHER]:** -`http://termbin.com/` +_{replace this section with your content or delete if not a FEATURE REQUEST/QUESTION/OTHER}_ **[BUG | ISSUE] Expected Behaviour:** -_{replace this section with your content or delete if not a BUG/ISSUE}_ **[BUG | ISSUE] Actual Behaviour:** -_{replace this section with your content or delete if not a BUG/ISSUE}_ **[BUG | ISSUE] Steps to reproduce:** -_{replace this section with your content or delete if not a BUG/ISSUE}_ - - - - - -**[FEATURE REQUEST | QUESTION | OTHER]:** +**(Optional) Debug Log generated by `pihole -d`:** -_{replace this line with your content or delete if not a FEATURE REQUEST/QUESTION/OTHER}_ +`http://termbin.com/`