From 2357b9fa21dacb70a61a541f323918f1413acfba Mon Sep 17 00:00:00 2001
From: Zedifus <zedifus@zediverse.gg>
Date: Sat, 6 Apr 2024 23:41:24 +0100
Subject: [PATCH] Make help text in repo templates comments.

People aren't removing the example text, thus MR's and issues are messy
---
 .gitlab/issue_templates/Bug.md             |  8 ++++----
 .gitlab/issue_templates/Change Request.md  |  7 ++++---
 .gitlab/issue_templates/Feature Request.md |  8 ++++----
 .gitlab/merge_request_templates/Default.md | 18 +++++++++---------
 4 files changed, 21 insertions(+), 20 deletions(-)

diff --git a/.gitlab/issue_templates/Bug.md b/.gitlab/issue_templates/Bug.md
index 88b2a3b4..77136b69 100644
--- a/.gitlab/issue_templates/Bug.md
+++ b/.gitlab/issue_templates/Bug.md
@@ -3,16 +3,16 @@
 - **Install Type:** Git Cloned(Manual) / Installer / WinPackage / Docker
 
 ## What Happened?
-*A brief description of what happened when you tried to perform an action*
+<!-- A brief description of what happened when you tried to perform an action -->
 
 ## Expected result
-*What should have happened when you performed the actions*
+<!-- What should have happened when you performed the actions -->
 
 ## Steps to reproduce
-*List the steps required to produce the error. These should be as few as possible*
+<!-- List the steps required to produce the error. These should be as few as possible -->
 
 ## Screenshots
-Any relevant screenshots which show the issue* !-->*
+<!-- Any relevant screenshots which show the issue -->
 
 ## Priority/Severity
 - [ ] High (anything that impacts the normal user flow or blocks app usage)
diff --git a/.gitlab/issue_templates/Change Request.md b/.gitlab/issue_templates/Change Request.md
index 995e7ad1..f767ee15 100644
--- a/.gitlab/issue_templates/Change Request.md	
+++ b/.gitlab/issue_templates/Change Request.md	
@@ -1,13 +1,14 @@
 ## Summary
-*Outline the issue being faced, and why this needs to change*
+<!-- Outline the issue being faced, and why this needs to change -->
 
 ## Area of the system
-*This might only be one part, but may involve multiple sections, Login/Dashboad/Terminal/Config*
+<!-- This might only be one part, but may involve multiple sections, Login/Dashboad/Terminal/Config -->
 
 ## How does this currently work?
+<!-- A brief description of how the functionality currently operates -->
 
 ## What is the desired way of working?
-*After the change, what should the process/operation be?*
+<!-- After the change, what should the process/operation be? -->
 
 ## Priority/Severity
 - [ ] High (This will bring a huge increase in performance/productivity/usability)
diff --git a/.gitlab/issue_templates/Feature Request.md b/.gitlab/issue_templates/Feature Request.md
index 2450aa60..b26067d6 100644
--- a/.gitlab/issue_templates/Feature Request.md	
+++ b/.gitlab/issue_templates/Feature Request.md	
@@ -1,8 +1,8 @@
 ## Problem Statement
-*What is the issue being faced and needs addressing?*
+<!-- What is the issue being faced and needs addressing? -->
 
 ## Who will benefit?
-*Will this fix a problem that only one user has, or will it benefit a lot of people*
+<!-- Will this fix a problem that only one user has, or will it benefit a lot of people -->
 
 ## Benefits and risks
     What benefits does this bring?
@@ -16,10 +16,10 @@
 
 
 ## Proposed solution
-*How would you like to see this issue resolved?*
+<!-- How would you like to see this issue resolved? -->
 
 ## Examples
-*Are there any examples of this which exist in other software?*
+<!-- Are there any examples of this which exist in other software? -->
 
 ## Priority/Severity
 - [ ] High (This will bring a huge increase in performance/productivity/usability)
diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md
index a82cb3f8..70bcd7db 100644
--- a/.gitlab/merge_request_templates/Default.md
+++ b/.gitlab/merge_request_templates/Default.md
@@ -1,22 +1,22 @@
 ## What does this MR do and why?
 
-___Describe in detail what your merge request does and why.___<br>
-> *Please keep this description updated with any discussion that takes place so*<br>
-*that reviewers can understand your intent. Keeping the description updated is*<br>
-*especially important if they didn't participate in the discussion.*<br>
+<!-- Describe in detail what your merge request does and why. -->
+<!-- Please keep this description updated with any discussion that takes place so -->
+<!-- that reviewers can understand your intent. Keeping the description updated is -->
+<!-- especially important if they didn't participate in the discussion. -->
 
 
 ## Screenshots or screen recordings
 
-___These are strongly recommended to assist reviewers and reduce the time to merge your change.___<br>
-> *Please include any relevant screenshots or screen recordings that will assist*<br>
-*reviewers and future readers. If you need help visually verifying the change,*<br>
-*please leave a comment and ping a GitLab reviewer, maintainer, or MR coach.*<br>
+<!-- These are strongly recommended to assist reviewers and reduce the time to merge your change. -->
+<!-- Please include any relevant screenshots or screen recordings that will assist, -->
+<!-- reviewers and future readers. If you need help visually verifying the change, -->
+<!-- please leave a comment and ping a GitLab reviewer, maintainer, or MR coach. -->
 
 
 ## How to set up and validate locally
 
-___Numbered steps to set up and validate the change are strongly suggested.___
+<!-- Numbered steps to set up and validate the change are strongly suggested. -->
 
 
 ## MR acceptance checklist