put informative text into markdown comments

qgis · Mar 12, 2019 · 42c9d61 · 42c9d61
1 parent 2f756a2
commit 42c9d61
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 15 deletions.
diff --git a/.github/bug_report.md b/.github/bug_report.md
@@ -6,29 +6,29 @@ labels: 'Bug report'
 assignees: ''
 
 ---
+<!--
+Bug fixing and feature development is a community responsibility, and not the responsibility of the QGIS project alone.
+If this bug report or feature request is high-priority for you, we suggest engaging a QGIS developer or support organisation and financially sponsoring a fix
 
-*Bug fixing and feature development is a community responsibility, and not the responsibility of the QGIS project alone.*
-*If this bug report or feature request is high-priority for you, we suggest engaging a QGIS developer or support organisation and financially sponsoring a fix*
+Checklist before submitting
 
-*Checklist before submitting*
+- [ ] Search through existing issue reports and gis.stackexchange.com to check whether the issue already exists
+- [ ] Test with a [clean new user profile](https://docs.qgis.org/testing/en/docs/user_manual/introduction/qgis_configuration.html?highlight=profile#working-with-user-profiles).
+- [ ] Create a light and self-contained sample dataset and project file which demonstrates the issue
 
-- [ ] *Search through existing issue reports and gis.stackexchange.com to check whether the issue already exists*
-- [ ] *Test with a [clean new user profile](https://docs.qgis.org/testing/en/docs/user_manual/introduction/qgis_configuration.html?highlight=profile#working-with-user-profiles).*
-- [ ] *Create a light and self-contained sample dataset and project file which demonstrates the issue*
-
-*If the issue concerns a **third party plugin**, then it **cannot** be fixed by the QGIS team. Please raise your issue in the dedicated bug tracker for that specific plugin (as listed in the plugin's description).*
+If the issue concerns a **third party plugin**, then it **cannot** be fixed by the QGIS team. Please raise your issue in the dedicated bug tracker for that specific plugin (as listed in the plugin's description). -->
 
 **Describe the bug**
-*A clear and concise description of what the bug is.*
+<!-- A clear and concise description of what the bug is. -->
 
 **How to Reproduce**
 
-*Steps, sample datasets and qgis project file to reproduce the behavior. Screencasts or screenshots welcome*
+<!-- Steps, sample datasets and qgis project file to reproduce the behavior. Screencasts or screenshots welcome
 
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
-4. See error
+4. See error -->
 
 
 **Desktop environment (please complete the following information):**
@@ -44,4 +44,4 @@ assignees: ''
 
 **Additional context**
 
-*Add any other context about the problem here.*
+<!-- Add any other context about the problem here. -->
diff --git a/.github/feature_request.md b/.github/feature_request.md
@@ -8,9 +8,9 @@ assignees: ''
 ---
 
 **Feature description.**
-*A clear and concise description of what you want to happen. Ex. QGIS would rock even more if [...]*
+<!-- A clear and concise description of what you want to happen. Ex. QGIS would rock even more if [...] -->
 
 
 **Additional context**
-*Add any other context or screenshots about the feature request here. Open source is community driven, please consider a way to support this work either by hiring developers, supporting the QGIS project, find someone to submit a pull request.*
-*If the change required is important, you should consider writing a [QGIS Enhancement Proposal](https://github.com/qgis/QGIS-Enhancement-Proposals/issues) (QEP) or hiring someone to, and announce your work on the lists.*
+<!-- Add any other context or screenshots about the feature request here. Open source is community driven, please consider a way to support this work either by hiring developers, supporting the QGIS project, find someone to submit a pull request.
+If the change required is important, you should consider writing a [QGIS Enhancement Proposal](https://github.com/qgis/QGIS-Enhancement-Proposals/issues) (QEP) or hiring someone to, and announce your work on the lists. -->