Update bug report template
This commit is contained in:
parent
653a477060
commit
a73dd5ef6a
82
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
82
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -4,51 +4,75 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: >-
|
value: >-
|
||||||
**Note: This issue tracker is not intended for support requests!** If you need help with crashes or other issues, then
|
**Need help?** Ask on [Discord](https://discord.gg/rN9Y7caguP) instead of opening an issue.
|
||||||
you should [ask on our Discord server](https://discord.gg/rN9Y7caguP) instead. Unless you are certain that you
|
|
||||||
have found a defect, and you are able to point to where the problem is, you should not open an issue.
|
|
||||||
<br><br>
|
|
||||||
Additionally, please make sure you have done the following:
|
|
||||||
|
|
||||||
- **Have you ensured that all of your mods (including ModernFix) are up-to-date?** The latest version of ModernFix
|
**Issues that do not meet the requirements below (or are otherwise impossible to address with the given info) will be closed without investigation.**
|
||||||
can always be found [on Modrinth](https://modrinth.com/mod/modernfix).
|
- type: checkboxes
|
||||||
|
id: confirmations
|
||||||
- **Have you used the [search tool](https://github.com/embeddedt/ModernFix/issues) to check whether your issue
|
attributes:
|
||||||
has already been reported?** If it has been, then consider adding more information to the existing issue instead.
|
label: Checklist
|
||||||
|
options:
|
||||||
- **Have you determined the minimum set of instructions to reproduce the issue?** If your problem only occurs
|
- label: I am reporting a defect, not asking for help
|
||||||
with other mods installed, then you should narrow down exactly which mods are causing the issue. Please do not
|
required: true
|
||||||
provide your entire list of mods to us and expect that we will be able to figure out the problem.
|
- label: I have searched existing issues and this has not been reported
|
||||||
|
required: true
|
||||||
|
- label: I have reduced my mod list to the minimum required to reproduce this issue (see below)
|
||||||
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Bug Description
|
label: Bug Description
|
||||||
description: >-
|
description: >-
|
||||||
Use this section to describe the issue you are experiencing in as much depth as possible. The description should
|
Describe the issue in detail. Be sure to include what you expected to happen and what actually happened.
|
||||||
explain what behavior you were expecting, and why you believe the issue to be a bug. If the issue you are reporting
|
validations:
|
||||||
only occurs with specific mods installed, then provide the name and version of each mod.
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: minimal-mods
|
||||||
|
attributes:
|
||||||
|
label: Minimal Mod List
|
||||||
|
description: >-
|
||||||
|
List ONLY the mods required to reproduce this issue. Maintainers have debugging tools that help them
|
||||||
|
locate problems quickly, but these generally don't work well in modpacks or large mod sets.
|
||||||
|
A minimal list should typically contain fewer than 10 mods.
|
||||||
|
|
||||||
**Hint:** If you have any screenshots, videos, or other information that you feel is necessary to
|
Reports with large mod lists will likely be closed without investigation, unless the problem is very clear.
|
||||||
explain the issue, you can attach them here.
|
|
||||||
|
If you don't know which mods are causing your problem, use binary search:
|
||||||
|
|
||||||
|
1. Remove half your mods
|
||||||
|
|
||||||
|
2. Test if the issue still occurs
|
||||||
|
|
||||||
|
3. If yes, remove half again. If no, restore the last removed half and repeat from step 1.
|
||||||
|
|
||||||
|
4. Repeat until only the necessary mods remain
|
||||||
|
placeholder: "- ModernFix 5.x.x\n- SomeMod 1.2.3"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: description-reproduction-steps
|
id: description-reproduction-steps
|
||||||
attributes:
|
attributes:
|
||||||
label: Reproduction Steps
|
label: Reproduction Steps
|
||||||
description: >-
|
description: >-
|
||||||
Provide as much information as possible on how to reproduce this bug. Make sure your instructions are as clear and
|
Provide clear steps to reproduce the bug. Each step should be a single concrete action.
|
||||||
concise as possible, because other people will need to be able to follow your guide in order to re-create the issue.
|
|
||||||
|
Maintainers are busy and need to be able to quickly replicate your problem. Your reproduction steps should be
|
||||||
**Hint:** A common way to fill this section out is to write a step-by-step guide.
|
clear enough for someone who is unfamiliar with your mods to follow in 5 minutes or less (not counting time
|
||||||
|
to launch the game).
|
||||||
|
|
||||||
|
Providing vague steps is likely to result in the issue being closed.
|
||||||
|
|
||||||
|
placeholder: "1. \n2. \n3. "
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: log-file
|
id: diagnostic-info
|
||||||
attributes:
|
attributes:
|
||||||
label: Log File
|
label: Diagnostic Info
|
||||||
description: >-
|
description: >-
|
||||||
**Hint:** You can usually find the log files within the folder `.minecraft/logs`. Most often, you will want the `latest.log`
|
Drag and drop `latest.log` from `.minecraft/logs/` for the session where the issue occurred.
|
||||||
file, since that file belongs to the last played session of the game.
|
Do not paste log text inline. Issues without a valid `latest.log` will be closed.
|
||||||
placeholder: >-
|
|
||||||
Drag-and-drop the log file here.
|
If a crash occurred, also attach the relevant file from `.minecraft/crash-reports/`.
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user