From c332c7debcb1616d3dd089595837b9eee6a1577e Mon Sep 17 00:00:00 2001
From: Ghostkeeper <rubend@tutanota.com>
Date: Fri, 25 Oct 2019 13:02:19 +0200
Subject: Improve issue templates

Two major changes here:
1. No longer include the instructions in comments. Quite often the filled in template was also in comments then because people don't know the HTML formatting. Also if the template is not completely filled in now, public shaming ensues.
2. The reproduce steps for bugs now suggest a numbered list of steps. Hopefully this will improve the bug reports we get with better reproduction steps.
---
 .github/ISSUE_TEMPLATE.md                 | 23 ++++++++++++-----------
 .github/ISSUE_TEMPLATE/bug-report.md      | 15 ++++++++-------
 .github/ISSUE_TEMPLATE/feature_request.md | 11 ++++++-----
 3 files changed, 26 insertions(+), 23 deletions(-)

(limited to '.github')

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index 2f880a9e32..8e56787aeb 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -11,23 +11,24 @@ Information about how to find the log file can be found at https://github.com/Ul
 Thank you for using Cura!
 -->
 
-**Application Version**
-<!-- The version of the application this issue occurs with -->
+**Application version**
+(The version of the application this issue occurs with.)
 
 **Platform**
-<!-- Information about the operating system the issue occurs on -->
+(Information about the operating system the issue occurs on. Include at least the operating system. In the case of visual glitches/issues, also include information about your graphics drivers and GPU.)
 
 **Printer**
-<!-- Which printer was selected in Cura. Please attach project file as .curaproject.3mf.zip -->
+(Which printer was selected in Cura? If possible, please attach project file as .curaproject.3mf.zip.)
 
-**Steps to Reproduce**
-<!-- Add the steps needed that lead up to the issue -->
+**Reproduction steps**
+1. Something you did.
+2. Something you did next.
 
-**Actual Results**
-<!-- What happens after the above steps have been followed -->
+**Actual results**
+(What happens after the above steps have been followed.)
 
 **Expected results**
-<!-- What should happen after the above steps have been followed -->
+(What should happen after the above steps have been followed.)
 
-**Additional Information**
-<!-- Extra information relevant to the issue, like screenshots -->
+**Additional information**
+(Extra information relevant to the issue, like screenshots. Don't forget to attach the log files with this issue report.)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
index a7371e02a6..749b8037c1 100644
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -22,22 +22,23 @@ Thank you for using Cura!
 -->
 
 **Application version**
-<!-- The version of the application this issue occurs with -->
+(The version of the application this issue occurs with.)
 
 **Platform**
-<!-- Information about the operating system the issue occurs on. Include at least the operating system. In the case of visual glitches/issues, also include information about your graphics drivers and GPU. -->
+(Information about the operating system the issue occurs on. Include at least the operating system. In the case of visual glitches/issues, also include information about your graphics drivers and GPU.)
 
 **Printer**
-<!-- Which printer was selected in Cura? If possible, please attach project file as .curaproject.3mf.zip -->
+(Which printer was selected in Cura? If possible, please attach project file as .curaproject.3mf.zip.)
 
 **Reproduction steps**
-<!-- How did you encounter the bug? -->
+1. Something you did.
+2. Something you did next.
 
 **Actual results**
-<!-- What happens after the above steps have been followed -->
+(What happens after the above steps have been followed.)
 
 **Expected results**
-<!-- What should happen after the above steps have been followed -->
+(What should happen after the above steps have been followed.)
 
 **Additional information**
-<!-- Extra information relevant to the issue, like screenshots. Don't forget to attach the log files with this issue report. -->
+(Extra information relevant to the issue, like screenshots. Don't forget to attach the log files with this issue report.)
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 2a0a3e4e7b..a10d664a04 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,15 +8,16 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+(A clear and concise description of what the problem is. Ex. I'm always frustrated when [...])
 
 **Describe the solution you'd like**
-<!--A clear and concise description of what you want to happen. If possible, describe why you think this is a good solution.-->
+(A clear and concise description of what you want to happen. If possible, describe why you think this is a good solution.)
 
 **Describe alternatives you've considered**
-<!-- A clear and concise description of any alternative solutions or features you've considered. Again, if possible, think about why these alternatives are not working out. -->
+(A clear and concise description of any alternative solutions or features you've considered. Again, if possible, think about why these alternatives are not working out.)
 
 **Affected users and/or printers**
-<!-- Who do you think will benefit from this? Is everyone going to benefit from these changes? Only a few people? --> 
+(Who do you think will benefit from this? Is everyone going to benefit from these changes? Or specific kinds of users?)
+
 **Additional context**
-<!-- Add any other context or screenshots about the feature request here. -->
+(Add any other context or screenshots about the feature request here.)
-- 
cgit v1.2.3