From 127c5908bbdfc9393f831fd6b7ef1f7ff0d80e8d Mon Sep 17 00:00:00 2001
From: martincostello <martin@martincostello.com>
Date: Mon, 23 May 2022 16:20:01 +0100
Subject: [PATCH] Tidy up issue templates

Use markdown headings and use comments for hints.
---
 .github/ISSUE_TEMPLATE.md                 | 20 +++++++---
 .github/ISSUE_TEMPLATE/bug_report.md      | 47 ++++++++++++++++-------
 .github/ISSUE_TEMPLATE/feature_request.md | 24 +++++++++---
 3 files changed, 66 insertions(+), 25 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index b52b31c3c..454ff58fa 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,19 +1,29 @@
 ### Provider name
 
-_State which provider(s) you are experiencing an issue with._
+<!--
+State which provider(s) you are experiencing an issue with.
+-->
 
 ### Expected behavior
 
-_Explain what you expected to happen._
+<!--
+Explain what you expected to happen.
+-->
 
 ### Actual behavior
 
-_Explain what actually happened. If an exception occurred, please include a stack trace if available._
+<!--
+Explain what actually happened. If an exception occurred, please include a stack trace if available.
+-->
 
 ### Steps to reproduce
 
-_A concise and repeatable example of how to illustrate the issue._
+<!--
+A concise and repeatable example of how to illustrate the issue.
+-->
 
 ### Additional information
 
-_Any additional information that may be useful, such as the version of the package you are using or the version of .NET Core._
+<!--
+Any additional information that may be useful, such as the version of the package you are using or the version of .NET.
+-->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index daa096f53..84c29d228 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,25 +1,44 @@
 ---
 name: Bug report
 about: Create a bug report to help us improve AspNet.Security.OAuth.Providers
+labels: bug
 
 ---
 
-**Describe the bug**
-_A clear and concise description of what the bug is. State which provider(s) the bug relates to._
+### Describe the bug
 
-**Steps To reproduce**
-_A concise and repeatable example of how to illustrate the issue._
+<!--
+A clear and concise description of what the bug is. State which provider(s) the bug relates to.
+-->
 
-**Expected behaviour**
-_A clear and concise description of what you expected to happen._
+### Steps To reproduce
 
-**Actual behaviour**
-_A clear and concise description of what actually happened. If an exception occurred, please include a stack trace if available._
+<!--
+A concise and repeatable example of how to illustrate the issue.
+-->
 
-**System information:**
- - OS: [e.g. Windows 10]
- - Library Version [e.g. 2.0.1]
- - .NET version (e.g. output from `dotnet --info`)
+### Expected behaviour
 
-**Additional context**
-_Add any other context about the problem here._
+<!--
+A clear and concise description of what you expected to happen.
+-->
+
+### Actual behaviour
+
+<!--
+A clear and concise description of what actually happened. If an exception occurred, please include a stack trace if available.
+-->
+
+### System information
+
+<!--
+- OS: [e.g. Windows 11]
+- Library Version [e.g. 6.0.0]
+- .NET version (e.g. output from `dotnet --info`)
+-->
+
+### Additional context
+
+<!--
+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 445510440..93d4439e5 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,14 +4,26 @@ about: Suggest an idea for a new feature for AspNet.Security.OAuth.Providers
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. For example: _I'm always frustrated when [...]_
+### Is your feature request related to a problem? Please describe.
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+<!--
+A clear and concise description of what the problem is. For example: _It would be useful if [...]_
+-->
 
-**Describe alternatives you've considered**
+### Describe the solution you'd like
+
+<!--
+A clear and concise description of what you would like to happen.
+-->
+
+### Describe alternatives you've considered
+
+<!--
 A clear and concise description of any alternative solutions or features you've considered.
+-->
+
+### Additional context
 
-**Additional context**
+<!--
 Add any other context or screenshots about the feature request here.
+-->