From 2ccf063dfeb2606bdd34c224b7967efb59487b7d Mon Sep 17 00:00:00 2001 From: WaLLy3K Date: Sat, 22 Jul 2017 15:15:39 +1000 Subject: [PATCH] Update Issue Template text --- .github/ISSUE_TEMPLATE.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 23e67795..185539ec 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,33 +1,36 @@ -**In raising this issue, I confirm the following (please check boxes, eg [X]) Failure to fill the template will close your issue:** +**In raising this issue, I confirm the following:** `{please fill the checkboxes, e.g: [X]}` - [] I have read and understood the [contributors guide](https://github.com/pi-hole/pi-hole/blob/master/CONTRIBUTING.md). -- [] The issue I am reporting can be *replicated* +- [] The issue I am reporting can be *replicated*. - [] The issue I am 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?:** +**How familiar are you with the the source code relevant to this issue?:** -_{replace this text with a number from 1 to 10, with 1 being not familiar, and 10 being very familiar}_ +`{Replace this with a number from 1 to 10. 1 being not familiar, and 10 being very familiar}` --- -**[BUG REPORT | OTHER]:** +**Expected behaviour:** -Please [submit your feature request here](https://discourse.pi-hole.net/c/feature-requests), so it is votable by the community. It's also easier for us to track. +`{A detailed description of what you expect to see}` -**[BUG | ISSUE] Expected Behaviour:** +**Actual behaviour:** +`{A detailed description and/or screenshots of what you do see}` -**[BUG | ISSUE] Actual Behaviour:** +**Steps to reproduce:** +`{Detailed steps of how we can reproduce this}` -**[BUG | ISSUE] Steps to reproduce:** +**Debug token provided by [uploading `pihole -d` log](https://pi-hole.net/2016/11/07/crack-our-medical-tricorder-win-a-raspberry-pi-3/):** -- -- -- -- +`{Alphanumeric token}` -**(Optional) Debug token generated by `pihole -d`:** +**Troubleshooting undertaken, and/or other relevant information:** -`` +`{Steps of what you have done to fix this}` -_This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._ +> * `{Please delete this quoted section when opening your issue}` +> * You must follow the template instructions. Failure to do so will result in your issue being closed. +> * Please respect that Pi-hole is developed by volunteers, who can only reply in their spare time. +> * Detail helps us understand and resolve an issue quicker, but please ensure it's relevant. +> * _This template was created based on the work of [`udemy-dl`](https://github.com/nishad/udemy-dl/blob/master/LICENSE)._