docs: fix template issues

kha7iq · Jun 15, 2021 · 7186e5d · 7186e5d
1 parent b85a045
commit 7186e5d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,6 +1,3 @@
-<!-- markdownlint-disable MD041 -->
-<!-- markdownlint-disable MD036 -->
-
 ---
 name: Bug report
 about: Create a report to help us improve
@@ -12,6 +9,7 @@ about: Create a report to help us improve
 A clear and concise description of what the bug is.
 
 **To Reproduce**
+
 Steps to reproduce the behavior:
 
 1. Go to '...'
@@ -20,9 +18,11 @@ Steps to reproduce the behavior:
 4. See error
 
 **Expected behavior**
+
 A clear and concise description of what you expected to happen.
 
 **Screenshots**
+
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
@@ -39,4 +39,5 @@ If applicable, add screenshots to help explain your problem.
 - Version [e.g. 22]
 
 **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
@@ -1,20 +1,22 @@
-<!-- markdownlint-disable MD041 -->
-<!-- markdownlint-disable MD036 -->
-
 ---
 name: Feature request
 about: Suggest an idea for this project
 
 ---
 
 **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 [...]
+
+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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -13,14 +13,14 @@ Please delete options that are not relevant.
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] This change requires a documentation update
 
-## How Has This Been Tested?
+# How Has This Been Tested?
 
 Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
 
 - [ ] Running existing tests
 - [ ] Created new tests
 
-## Checklist
+# Checklist:
 
 - [ ] My code has been linted (`make lint`)
 - [ ] I have performed a self-review of my own code