Engine/.forgejo/issue_template/helprequest.yml

89 lines
3.2 KiB
YAML

name: "💬 Help"
about: "Request help."
title: "help: "
labels:
- "Help/Wanted"
body:
- type: "markdown"
id: "text-introduction"
attributes:
value: |
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 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"
attributes:
label: "Problem description"
description: "Explain what your problem is as detailed as possible."
placeholder: "How can I create a custom LoggerImplementation implementation?"
validations:
required: true
- type: "textarea"
id: "help-log"
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) 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..."
value: |
```plain
Your log file here...
```
validations:
required: false
- type: "textarea"
id: "help-snippet"
attributes:
label: "Code snippet"
description: |
Please insert a snippet of the application code which you think is causing the issue.
**This field can be left empty if the problem you are faciing does not involve/require code.**
value: |
```java
Your code snippet here...
```
validations:
required: false
- type: "input"
id: "engine-version"
attributes:
label: "Full engine version"
description: |
Input the full engine version here.
Simply copy the `Initialized sos!engine v<version> (commit <commit>-<branch>, dirty <dirty>) in <inittime>ms` message here.
placeholder: "Example: sos!engine v1-alpha4 (commit 05b9644eba5263809b6655dabb92669523a95805-develop, dirty true)"
validations:
required: true
- type: "dropdown"
id: "jvm-java"
attributes:
label: "Java version"
description: "Which Java version is your application compiled against?"
options:
- "20 and lower"
- "21"
- "22"
- "23"
validations:
required: true
- type: "input"
id: "os"
attributes:
label: "Operating system"
description: "Name the operating system, version (if applicable) and CPU architecture the error occurs on. This may be some Linux distribution, Android or Windoze on `amd64`/`aarch64`/`ppc64`/etc.."
placeholder: "Example: Debian trixie (amd64)"
validations:
required: true
- type: "markdown"
id: "text-tysm"
attributes:
value: |
Thank you for filling out this help form.
Please check your answers for *mistaeks* or sensitive information before sending this help request.