Fix smaller issues in issue templates

This commit is contained in:
JeremyStar™ 2024-08-18 12:11:21 +02:00
parent f03563229b
commit 57b2f000c7
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
3 changed files with 15 additions and 8 deletions

View file

@ -27,8 +27,8 @@ body:
attributes:
label: "Bug log"
description: |
Please insert the ENTIRE log output here, so we can understand the problem at hand.
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM args) with the default log template.
Please insert the ENTIRE log output here, so we can understand the problem at hand. \
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM) with the default log template.
**This field can be left empty if the bug does not involve/require log output.**
placeholder: "Your log file here..."

View file

@ -20,14 +20,18 @@ body:
attributes:
label: "Feature description"
description: "Explain *what* you want added. Include as many details as possible."
placeholder: "Example: I want to do X in my project, which would simplify doing Y."
placeholder: |
Example:
I want to do X in my project, which would simplify doing Y.
validations:
required: true
- type: "textarea"
id: "feature-implementation"
attributes:
label: "Feature implementation"
description: "Explain *how* you want it added. Include as many details as possible. Also explore alternative ways of implementing the feature in the engine (if possible)."
description: |
Explain *how* you want it added. Include as many details as possible.
Also explore alternative ways of implementing the feature in the engine (if possible).
placeholder: |
Example:
I would propose to <some description on how to implement your feature>.
@ -38,7 +42,10 @@ body:
id: "feature-alternatives"
attributes:
label: "Feature alternatives"
description: "Explain how could be possible to implement the feature without building it into the engine directly. Include as many details as possible. **Leave empty if it can't simply be solved by creating a subsystem.**"
description: |
Explain how to implement the feature without building it into the engine directly. Include as many details as possible.
**Leave empty if it can't simply be solved by creating a subsystem.**
placeholder: |
Example:
I've considered writing a subsystem for this feature.

View file

@ -11,7 +11,7 @@ body:
Hey there! Seems like you have some kind of issue with the StarOpenSource Engine. \
Please answer the following questions accurately, otherwise we may not be able to help you. \
\
**Please check if the same bug report already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
**Please check if the same help request already exists. If so, participate in that one instead. If another issue is similar, make sure to mention the related issues.** \
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your stuff, we censor our answers.**
- type: "textarea"
id: "help-description"
@ -26,8 +26,8 @@ body:
attributes:
label: "Log"
description: |
Please insert the ENTIRE log output here, so we can understand the problem at hand.
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM args) with the default log template.
Please insert the ENTIRE log output here, so we can understand the problem at hand. \
You must give us `DIAGNOSTIC` level logs (pass `-Dsosengine.base.loggerLevel=diagnostic` to the JVM) with the default log template.
*This field can be left empty if the problem you are faciing does not involve/require log output.**
placeholder: "Your log file here..."