hotfix: improve template comments

epiforecasts · Feb 19, 2024 · 7568882 · 7568882
1 parent 94c7fe2
commit 7568882
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 12 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,7 +9,8 @@ assignees: ''
 ---
 
 <!-- Thank you for reporting a bug. Please use the section headers below
-     for providing more detail where appropriate -->
+     for providing more detail where appropriate
+-->
 
 Summary:
 Please provide a short summary (no more than a sentence or two).

diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
@@ -8,8 +8,10 @@ labels: ''
 assignees: ''
 ---
 
-<!-- Thank you for helping improve our documentation. Please use the section
-headers below for providing more detail where appropriate -->
+<!--
+  Thank you for helping improve our documentation. Please use the section
+  headers below for providing more detail where appropriate
+-->
 
 Type of issue:
 State whether you are commenting on existing documentation / vignettes, or suggesting a new vignette.

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -6,8 +6,10 @@ labels: ''
 assignees: ''
 ---
 
-<!-- Thank you for suggesting a feature. Please use the section headers below
-     for providing more detail where appropriate -->
+<!--
+  Thank you for suggesting a feature. Please use the section headers below for
+  providing more detail where appropriate
+-->
 
 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 [...]

diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md
@@ -6,5 +6,8 @@ labels: ''
 assignees: ''
 ---
 
-Please include a brief description of the issue and any proposed solutions you may have.
+<!--
+  Please include a brief description of the issue and any proposed solutions
+  you may have.
+-->
 
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,10 +1,12 @@
-<!-- Thanks for opening this Pull Request! Below we have provided a suggested 
-     template for PRs to this repository and a checklist to complete before 
-     opening a PR -->
+<!--
+  Thanks for opening this Pull Request! Below we have provided a suggested
+  template for PRs to this repository and a checklist to complete before
+  opening a PR.
  
-<!-- If this is your first Pull Request, please make sure you read the 
-     contributing guidelines linked below and at 
-     https://github.com/epiforecasts/EpiNow2/blob/main/.github/CONTRIBUTING.md -->
+  If this is your first Pull Request, please make sure you read the
+  contributing guidelines linked below and at
+  https://github.com/epiforecasts/EpiNow2/blob/main/.github/CONTRIBUTING.md
+-->
 
 ## Description