From 1509301779c508d975f193881ad64ec8d9cdb3e5 Mon Sep 17 00:00:00 2001
From: Gautier P <gautier+git@damsy.net>
Date: Fri, 11 Sep 2020 23:03:07 +0200
Subject: [PATCH] Improve bug templates

---
 .github/ISSUE_TEMPLATE/2-faq-report.md      |  2 +-
 .github/ISSUE_TEMPLATE/3-bug-report.md      | 18 ++++++++++--------
 .github/ISSUE_TEMPLATE/4-routing-report.md  | 14 ++++++++++----
 .github/ISSUE_TEMPLATE/5-feature-request.md |  9 +++++----
 4 files changed, 26 insertions(+), 17 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/2-faq-report.md b/.github/ISSUE_TEMPLATE/2-faq-report.md
index fbc18c4381..531d263d7f 100644
--- a/.github/ISSUE_TEMPLATE/2-faq-report.md
+++ b/.github/ISSUE_TEMPLATE/2-faq-report.md
@@ -1,8 +1,8 @@
 ---
 name: "📚 Outdated FAQ"
 about: Report an issue in FAQ
-
 ---
+
 🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑🛑
 
 Please do not file FAQ issues on the GitHub issues tracker.
diff --git a/.github/ISSUE_TEMPLATE/3-bug-report.md b/.github/ISSUE_TEMPLATE/3-bug-report.md
index d12ea14578..ecf870be10 100644
--- a/.github/ISSUE_TEMPLATE/3-bug-report.md
+++ b/.github/ISSUE_TEMPLATE/3-bug-report.md
@@ -2,6 +2,7 @@
 name: "\U0001F41E Bug report"
 about: Report a bug in OsmAnd
 ---
+
 <!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
 
 Oh hi there! 😄
@@ -28,29 +29,29 @@ Please give us the following information so that we can try to **reproduce** you
 <!-- Did this behavior use to work in the previous version? -->
 <!-- ✍️--> Yes, the previous version in which this bug was not present was: ....
 
-
 ### Description
 
-<!-- ✍️--> A clear and concise description of the problem...
-
+<!-- A clear and concise description of the problem... -->
 
 ## 🔬 Minimal Reproduction
+
 <!--
 If the bug is reproducible, please describe steps below:
 -->
 <!-- ✍️--> 1. Open app, and click on ...
 
 ## 🔥 Exception or Error
+
 <pre><code>
 <!-- If the issue is accompanied by an exception or an error, please share it below: -->
 <!-- ✍️-->
 
 </code></pre>
 
-
-## 🌍  Your Environment
+## 🌍 Your Environment
 
 **OsmAnd Version:**
+
 <pre><code>
 <!-- paste version below -->
 <!-- ✍️-->
@@ -60,10 +61,11 @@ If the bug is reproducible, please describe steps below:
 **Device and Android/iOS version:**
 
 **Maps used (online or offline):**
+
 <!-- Please tick the correct box [x] (or both) -->
-- [ ] Offline maps offered within the OsmAnd app for download. 
-  <!-- If you have an issue related to offline maps, tell us the exact name of the map file where the issue occurs and its edition date. -->
+
+- [ ] Offline maps offered within the OsmAnd app for download.
+<!-- If you have an issue related to offline maps, tell us the exact name of the map file where the issue occurs and its edition date. -->
 - [ ] Online (tile / raster) maps <!-- Please name it -->
 
-
 **Anything else relevant?**
diff --git a/.github/ISSUE_TEMPLATE/4-routing-report.md b/.github/ISSUE_TEMPLATE/4-routing-report.md
index 4c1e68c11a..216cd4b402 100644
--- a/.github/ISSUE_TEMPLATE/4-routing-report.md
+++ b/.github/ISSUE_TEMPLATE/4-routing-report.md
@@ -2,6 +2,7 @@
 name: "\U0001F6A9 Routing report"
 about: Report a routing issue in OsmAnd
 ---
+
 <!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
 
 Oh hi there! 😄
@@ -26,10 +27,12 @@ Please give us the following information so that we can try to **reproduce** you
 ### Routing engine
 
 <!-- Which routing provider was used? (please tick the proper box [x]) -->
+
 - [ ] OsmAnd's in-app offline routing
 - [ ] Any online routing provider (YOURS, OpenRouteService, OSRM, etc.)
 
 ### Routing Profile
+
 <!-- What routing profile is chosen in the OsmAnd app? (car, bike, pedestrian, fastest or shortest, etc.) -->
 
 ### Start and end points
@@ -38,6 +41,7 @@ Please give us the following information so that we can try to **reproduce** you
 Also, a permalink from [openstreetmap.org](https://www.openstreetmap.org/) can be helpful. -->
 
 ### Actual and expected routes
+
 <!-- Tell us your expected routing and how OsmAnd routes, or add screenshots here. -->
 
 ### Is this a regression?
@@ -45,9 +49,10 @@ Also, a permalink from [openstreetmap.org](https://www.openstreetmap.org/) can b
 <!-- Did this behavior use to work in the previous version? -->
 <!-- ✍️--> Yes, the previous version in which this bug was not present was: ....
 
-## 🌍  Your Environment
+## 🌍 Your Environment
 
 **OsmAnd Version:**
+
 <pre><code>
 <!-- paste version below -->
 <!-- ✍️-->
@@ -57,10 +62,11 @@ Also, a permalink from [openstreetmap.org](https://www.openstreetmap.org/) can b
 **Device and Android/iOS version:**
 
 **Maps used (online or offline):**
+
 <!-- Please tick the correct box [x] (or both) -->
-- [ ] Offline maps offered within the OsmAnd app for download. 
-  <!-- If you have an issue related to offline maps, tell us the exact name of the map file where the issue occurs and its edition date. -->
+
+- [ ] Offline maps offered within the OsmAnd app for download.
+<!-- If you have an issue related to offline maps, tell us the exact name of the map file where the issue occurs and its edition date. -->
 - [ ] Online (tile / raster) maps <!-- Please name it -->
 
-
 **Anything else relevant?**
diff --git a/.github/ISSUE_TEMPLATE/5-feature-request.md b/.github/ISSUE_TEMPLATE/5-feature-request.md
index 046fb3a90f..9c46069f8c 100644
--- a/.github/ISSUE_TEMPLATE/5-feature-request.md
+++ b/.github/ISSUE_TEMPLATE/5-feature-request.md
@@ -1,11 +1,11 @@
 ---
 name: "\U0001F680 Feature request"
 about: Suggest a feature for OsmAnd
-
 ---
+
 <!--🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅
 
-Oh hi there! 😄 
+Oh hi there! 😄
 
 To expedite issue processing please search open and closed issues before submitting a new one.
 Existing issues often contain information about workarounds, resolution, or progress updates.
@@ -22,12 +22,13 @@ Please be sure to read our [FAQ](https://osmand.net/help-online) before creating
 # 🚀 feature request
 
 ### Description
-<!-- ✍️--> A clear and concise description of the problem or missing capability...
 
+<!-- ✍️ A clear and concise description of the feature... -->
 
 ### Describe the solution you'd like
+
 <!-- ✍️--> If you have a solution in mind, please describe it.
 
-
 ### Describe alternatives you've considered
+
 <!-- ✍️--> Have you considered any alternative solutions or workarounds?