Make help text in repo templates comments.

People aren't removing the example text, thus MR's and issues are messy
This commit is contained in:
Zedifus 2024-04-06 23:41:24 +01:00
parent cb98402878
commit 2357b9fa21
4 changed files with 21 additions and 20 deletions

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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