From ae29456b3f2995166e2210d47d8917cb2e1cb744 Mon Sep 17 00:00:00 2001
From: Niels Lohmann <mail@nlohmann.me>
Date: Wed, 20 May 2020 18:57:21 +0200
Subject: [PATCH] :children_crossing: overwork report templates

---
 .github/ISSUE_TEMPLATE/Bug_report.md      | 49 +++++++++++++++++++----
 .github/ISSUE_TEMPLATE/Feature_request.md |  9 ++++-
 .github/ISSUE_TEMPLATE/question.md        | 26 ++++++++++--
 3 files changed, 71 insertions(+), 13 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md
index 748357a9..3485a689 100644
--- a/.github/ISSUE_TEMPLATE/Bug_report.md
+++ b/.github/ISSUE_TEMPLATE/Bug_report.md
@@ -7,16 +7,51 @@ assignees: ''
 
 ---
 
-- What is the issue you have?
+<!-- Provide a concise summary of the issue in the title above. -->
 
-- Please describe the steps to reproduce the issue. Can you provide a small but working code example?
+#### What is the issue you have?
 
-- What is the expected behavior?
+<!-- Provide a detailed introduction to the issue itself, and why you consider it to be a bug. -->
+<!-- If possible, be specific and add stack traces, error messages, etc. Avoid vague terms like "crash" or "doesn't work". -->
 
-- And what is the actual behavior instead?
+#### Please describe the steps to reproduce the issue.
 
-- Which compiler and operating system are you using? Is it a [supported compiler](https://github.com/nlohmann/json#supported-compilers)?
+<!-- Provide a link to a live example, or an unambiguous set of steps to -->
+<!-- reproduce this bug. Include code to reproduce, if relevant -->
 
-- Did you use a released version of the library or the version from the `develop` branch?
+1.
+2.
+3.
 
-- If you experience a compilation error: can you [compile and run the unit tests](https://github.com/nlohmann/json#execute-unit-tests)?
+#### Can you provide a small but working code example?
+
+<!-- Please understand that we cannot analyze and debug large code bases. -->
+
+#### What is the expected behavior?
+
+<!-- Tell us what should happen -->
+
+#### And what is the actual behavior instead?
+
+<!-- Tell us what happens instead. -->
+
+#### Which compiler and operating system are you using?
+
+<!-- Include as many relevant details about the environment you experienced the bug in. -->
+<!-- Make sure you use a supported compiler, see https://github.com/nlohmann/json#supported-compilers. -->
+
+- Compiler: ___
+- Operating system: ___
+
+#### Which version of the library did you use?
+
+<!-- Please add an `x` to the respective line. -->
+
+- [ ] latest release version 3.7.3
+- [ ] other release - please state the version: ___
+- [ ] the `develop` branch
+
+#### If you experience a compilation error: can you [compile and run the unit tests](https://github.com/nlohmann/json#execute-unit-tests)?
+
+- [ ] yes
+- [ ] no - please copy/paste the error message below
diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md
index 05a2c946..3652a1ee 100644
--- a/.github/ISSUE_TEMPLATE/Feature_request.md
+++ b/.github/ISSUE_TEMPLATE/Feature_request.md
@@ -7,6 +7,11 @@ assignees: ''
 
 ---
 
-- Describe the feature in as much detail as possible.
+#### Which feature do you want to see in the library?
+
+<!-- Describe the feature in as much detail as possible. -->
+
+#### How would the feature be usable for other users?
+
+<!-- Include sample usage where appropriate. -->
 
-- Include sample usage where appropriate.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
index 0870cd17..ec3ad69e 100644
--- a/.github/ISSUE_TEMPLATE/question.md
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -7,10 +7,28 @@ assignees: ''
 
 ---
 
-- Describe what you want to achieve.
+#### What do you want to achieve?
 
-- Describe what you tried.
+<!-- Please describe the feature as detailed as possible. -->
 
-- Describe which system (OS, compiler) you are using.
+#### What have you tried?
 
-- Describe which version of the library you are using (release version, develop branch).
+<!-- There are thousands of issues to search: https://github.com/nlohmann/json/issues?q=is%3Aissue+ -->
+<!-- There is a full documentation of the API: https://nlohmann.github.io/json/ -->
+<!-- There is a detailed README file: https://github.com/nlohmann/json/blob/develop/README.md -->
+
+#### Which compiler and operating system are you using?
+
+<!-- Include as many relevant details about the environment you experienced the bug in. -->
+<!-- Make sure you use a supported compiler, see https://github.com/nlohmann/json#supported-compilers. -->
+
+- Compiler: ___
+- Operating system: ___
+
+#### Which version of the library did you use?
+
+<!-- Please add an `x` to the respective line. -->
+
+- [ ] latest release version 3.7.3
+- [ ] other release - please state the version: ___
+- [ ] the `develop` branch