2024-08-18 12:00:24 +02:00
name : "⚠️ Bug report"
about : "Report a bug in the engine."
title : "bug: "
labels :
- "Bug/New"
body :
- type : "markdown"
id : "text-introduction"
attributes :
value : |
Hey there! Thank you for taking the time to report a bug to us. \
This means a lot to us, as that's the only way to get better... and many people don't file bug reports. \
Anyway, please answer the following questions accurately, otherwise we may not be able to diagnose the issue. \
\
2024-08-18 12:04:24 +02:00
**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.** \
2024-08-18 12:01:02 +02:00
**Please don't censor anything *except* sensitive information. You don't need to be embarrased about your username. You censor your bug report, we censor our answers.**
2024-08-18 12:00:24 +02:00
- type : "textarea"
id : "bug-description"
attributes :
label : "Bug description"
description : "Explain what the bug is about. Include as many details as possible."
placeholder : "My cat spontaneously explodes when I try to download from `https://yourdick.zip`."
validations :
required : true
- type : "textarea"
id : "bug-log"
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.
**This field can be left empty if the bug does not involve/require log output.**
placeholder : "Your log file here..."
value : |
```plain
Your log file here...
```
validations :
required : false
- type : "textarea"
id : "bug-snippet"
attributes :
label : "Bug snippet"
description : |
Please insert a snippet of the (application and/or engine) code which you think is causing the issue.
**This field can be left empty if you intend on supplying a reproduction project.**
value : |
```java
Your code snippet here...
```
validations :
required : false
- type : "textarea"
id : "bug-reproduce"
attributes :
label : "Bug reproduction guide"
description : |
Explain how we can reproduce this bug as easy as possible, step by step.
**This field can be left empty if the bug does not involve/require a reproduction guide.**
placeholder : |
1 . Pass "-Dsosengine.base.optimizeLogging=false" to the JVM
2 . Override logging implementation
2 . Initialize engine
4 . The nearest cat should explode in the next few seconds
validations :
required : false
- type : "input"
id : "bug-reproduce-project"
attributes :
label : "Bug reproduction project"
description : |
Drop a link to some repository or zip file of an example project showcasing the bug.
**Only supply a repro project if the bug is a bit more advanced, needs specific timing, etc..** \
**Also please make sure that the bug actually occurs in the example project!**"
placeholder : "https://your.reproduction.project/download/url/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 bug report.
Please check your answers for *mistaeks* or sensitive information before sending this report.