From 41d1be24cc3c3280fe8bc08cc5c6b1047f7ce9cd Mon Sep 17 00:00:00 2001
From: Benoit Blanchon <git@benoitblanchon.fr>
Date: Mon, 11 Oct 2021 15:08:37 +0200
Subject: [PATCH] Update GitHub issue templates

---
 .github/ISSUE_TEMPLATE.md                 | 14 ------
 .github/ISSUE_TEMPLATE/bug_report.md      | 54 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml         |  8 ++++
 .github/ISSUE_TEMPLATE/feature_request.md | 19 ++++++++
 .github/ISSUE_TEMPLATE/help.md            | 51 +++++++++++++++++++++
 5 files changed, 132 insertions(+), 14 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 .github/ISSUE_TEMPLATE/help.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index cddc522f..00000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,14 +0,0 @@
-<!--
-Before opening an issue, please read the FAQ:
-https://arduinojson.org/faq/
-
-Please provide all the relevant information:
-* good title
-* short description of the problem
-* target platform
-* compiler model and version
-* MVCE (https://stackoverflow.com/help/mcve)
-* compiler output
-
-Good questions get fast answers!
--->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..aaa35d16
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,54 @@
+---
+name: 🐛 Bug report
+about: Report a bug in ArduinoJson
+title: ''
+labels: 'bug'
+assignees: ''
+---
+
+<!-- ⚠️ IMPORTANT ⚠️
+Before opening a bug report, please use the ArduinoJson Troubleshooter as it may find a solution to your issue; if not, please include the  Troubleshooter's report in the description.
+-->
+
+**Describe the bug**  
+A clear and concise description of what the bug is.
+
+**Troubleshooter report**  
+Here is the report generated by the [ArduinoJson Troubleshooter](https://arduinojson.org/v6/troubleshooter/):  
+[Paste the report here]
+
+**Environment**  
+Here is the environment that I used:
+* Microcontroller: [e.g. ESP8266]
+* Core/runtime: [e.g. ESP8266 core for Arduino v3.0.2]
+* IDE: [e.g. Arduino IDE 1.8.16]
+
+**Reproduction**  
+Here is a small snippet that reproduces the issue.
+
+```c++
+DynamicJsonDocument doc(1024);
+
+DeserializationError error = deserializeJson(doc, "{\"hello\":\"world\"}");
+
+[insert repro code here]
+```
+
+**Compiler output**    
+If relevant, include the complete compiler output (i.e. not just the line that contains the error.)
+
+
+**Program output**  
+If relevant, include the repro program output.
+
+Expected output:
+
+```
+[insert expected output here]
+```
+
+Actual output:
+
+```
+[insert actual output here]
+```
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 00000000..4cfe33ae
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: 👨‍🏫 ArduinoJson Assistant
+    url: https://arduinojson.org/v6/assistant/
+    about: An online tool that computes memory requirements and generates scaffolding code for your project.
+  - name: 👨‍⚕️ ArduinoJson Troubleshooter
+    url: https://arduinojson.org/v6/troubleshooter/
+    about: An online tool that helps you diagnose the most common issues with ArduinoJson.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..889baaf2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,19 @@
+---
+name: 💡 Feature request
+about: Suggest an idea for ArduinoJson
+title: ''
+labels: enhancement
+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 [...]
+
+**Describe the solution you'd like**  
+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.
+
+**Additional context**  
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/help.md b/.github/ISSUE_TEMPLATE/help.md
new file mode 100644
index 00000000..d367679b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/help.md
@@ -0,0 +1,51 @@
+---
+name: 😭 Help!
+about: Ask for help
+title: ''
+labels: 'question'
+assignees: ''
+---
+
+<!-- ⚠️ IMPORTANT ⚠️
+Before asking for help, please use the ArduinoJson Troubleshooter as it may find a solution to your issue; if not, please include the  Troubleshooter's report in the description.
+-->
+
+**Describe the issue**  
+A clear and concise description of what you're trying to do.
+You don't need to explain every aspect of your project: focus on the problem you're having.
+
+**Troubleshooter report**  
+Here is the report generated by the [ArduinoJson Troubleshooter](https://arduinojson.org/v6/troubleshooter/):  
+[Paste the report here]
+
+**Environment**  
+Here is the environment that I'm using':
+* Microconroller: [e.g. ESP8266]
+* Core/runtime: [e.g. ESP8266 core for Arduino v3.0.2]
+* IDE: [e.g. Arduino IDE 1.8.16]
+
+**Reproduction**  
+Here is a small snippet that demonstrate the problem.
+
+```c++
+DynamicJsonDocument doc(1024);
+
+DeserializationError error = deserializeJson(doc, "{\"hello\":\"world\"}");
+
+// insert code here
+```
+
+**Program output**  
+If relevant, include the program output.
+
+Expected output:
+
+```
+[insert expected output here]
+```
+
+Actual output:
+
+```
+[insert actual output here]
+```