From bd8c764f49703ecc5cf25153144ad439c1ca2442 Mon Sep 17 00:00:00 2001
From: BonfaceKilz
Date: Tue, 3 Nov 2020 22:08:59 +0300
Subject: Update issue and PR templates

* .github/ISSUE_TEMPLATE/bug_report.md: Provide explanations in
commented out blocks.
* .github/ISSUE_TEMPLATE/feature_request.md: Ditto.
* .github/PULL_REQUEST_TEMPLATE.md: Ditto.
* .github/ISSUE_TEMPLATE/user_story.md: Ditto.
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 16 ++++++++--------
 .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++++--------
 .github/ISSUE_TEMPLATE/user_story.md      |  8 ++++----
 3 files changed, 27 insertions(+), 20 deletions(-)

(limited to '.github/ISSUE_TEMPLATE')

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 7d7e34a5..48bad39b 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,26 +9,26 @@ assignees: ''
 
 **Describe the bug**
 
-A clear and concise description of what the bug is.
+<!-- A clear and concise description of what the bug is. -->
 
 **To Reproduce**
 
-Steps to reproduce the behavior
+<!-- Steps to reproduce the behavior -->
 
 **Expected behavior**
 
-A clear and concise description of what you expected to happen.
+<!-- A clear and concise description of what you expected to happen. -->
 
 **Screenshots**
 
-If applicable, add screenshots to help explain your problem.
+<!-- If applicable, add screenshots to help explain your problem. -->
 
 **Environment setup (please complete the following information):**
 
-- OS: [e.g. Linux]
-- Guix Version (optional)
-- [Anything else you think is relevant]
+<!-- - OS: [e.g. Linux] -->
+<!-- - Guix Version (optional) -->
+<!-- - [Anything else you think is relevant] -->
 
 **Additional context**
 
-Add any other context about the problem here.
+<!-- Add any other context about the problem here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 254754c6..eb6c3e4b 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -9,26 +9,33 @@ 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. -->
+
+<!-- Example: I'm always frustrated when [...] -->
 
 ## Describe the solution you'd like
 
-A clear and concise description of what you want to happen.
+<!-- A clear and concise description of what you want to happen. -->
 
 ## Describe alternatives you've considered
 
-A clear and concise description of any alternative solutions or features you've considered.
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
 ## User Stories (optional)
 
-As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_
+<!-- Example: -->
+
+<!-- As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_ -->
+
+<!-- **Feature:** _[Brief description of feature]_ -->
 
-**Feature:** _[Brief description of feature]_
+<!-- _[Any additional descriptions on feature]_ -->
 
-_[Any additional descriptions on feature]_
+<!-- **Scenario:**
 
-**Scenario:** Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ here
+Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_
+here -->
 
 ## Additional context
 
-Add any other context or screenshots about the feature request here.
+<!-- Add any other context or screenshots about the feature request here. -->
diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md
index 2682fc98..52ae775d 100644
--- a/.github/ISSUE_TEMPLATE/user_story.md
+++ b/.github/ISSUE_TEMPLATE/user_story.md
@@ -7,10 +7,10 @@ assignees: ''
 
 ---
 
-As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_
+<!-- As a _[role or persona]_, I want _[goal/ need]_ so that _[why]_ -->
 
-**Feature:** _[Brief description of feature]_
+<!-- **Feature:** _[Brief description of feature]_ -->
 
-_[Any additional descriptions on feature]_
+<!-- _[Any additional descriptions on feature]_ -->
 
-**Scenario:** Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ here
+<!-- **Scenario:** Please use _[Gherkin](https://cucumber.io/docs/gherkin/reference/)_ here -->
-- 
cgit v1.2.3