|
4 | 4 | - type: markdown |
5 | 5 | attributes: |
6 | 6 | value: >- |
7 | | - **Note: This issue tracker is not intended for support requests!** If you need help with crashes or other issues, then |
8 | | - you should [ask on our Discord server](https://discord.gg/rN9Y7caguP) instead. Unless you are certain that you |
9 | | - have found a defect, and you are able to point to where the problem is, you should not open an issue. |
10 | | - <br><br> |
11 | | - Additionally, please make sure you have done the following: |
| 7 | + **Need help?** Ask on [Discord](https://discord.gg/rN9Y7caguP) instead of opening an issue. |
12 | 8 | |
13 | | - - **Have you ensured that all of your mods (including ModernFix) are up-to-date?** The latest version of ModernFix |
14 | | - can always be found [on Modrinth](https://modrinth.com/mod/modernfix). |
15 | | - |
16 | | - - **Have you used the [search tool](https://github.com/embeddedt/ModernFix/issues) to check whether your issue |
17 | | - has already been reported?** If it has been, then consider adding more information to the existing issue instead. |
18 | | - |
19 | | - - **Have you determined the minimum set of instructions to reproduce the issue?** If your problem only occurs |
20 | | - with other mods installed, then you should narrow down exactly which mods are causing the issue. Please do not |
21 | | - provide your entire list of mods to us and expect that we will be able to figure out the problem. |
| 9 | + **Issues that do not meet the requirements below (or are otherwise impossible to address with the given info) will be closed without investigation.** |
| 10 | + - type: checkboxes |
| 11 | + id: confirmations |
| 12 | + attributes: |
| 13 | + label: Checklist |
| 14 | + options: |
| 15 | + - label: I am reporting a defect, not asking for help |
| 16 | + required: true |
| 17 | + - label: I have searched existing issues and this has not been reported |
| 18 | + required: true |
| 19 | + - label: I have reduced my mod list to the minimum required to reproduce this issue (see below) |
| 20 | + required: true |
22 | 21 | - type: textarea |
23 | 22 | id: description |
24 | 23 | attributes: |
25 | 24 | label: Bug Description |
26 | 25 | description: >- |
27 | | - Use this section to describe the issue you are experiencing in as much depth as possible. The description should |
28 | | - explain what behavior you were expecting, and why you believe the issue to be a bug. If the issue you are reporting |
29 | | - only occurs with specific mods installed, then provide the name and version of each mod. |
| 26 | + Describe the issue in detail. Be sure to include what you expected to happen and what actually happened. |
| 27 | + validations: |
| 28 | + required: true |
| 29 | + - type: textarea |
| 30 | + id: minimal-mods |
| 31 | + attributes: |
| 32 | + label: Minimal Mod List |
| 33 | + description: >- |
| 34 | + List ONLY the mods required to reproduce this issue. Maintainers have debugging tools that help them |
| 35 | + locate problems quickly, but these generally don't work well in modpacks or large mod sets. |
| 36 | + A minimal list should typically contain fewer than 10 mods. |
| 37 | +
|
| 38 | + Reports with large mod lists will likely be closed without investigation, unless the problem is very clear. |
| 39 | +
|
| 40 | + If you don't know which mods are causing your problem, use binary search: |
30 | 41 |
|
31 | | - **Hint:** If you have any screenshots, videos, or other information that you feel is necessary to |
32 | | - explain the issue, you can attach them here. |
| 42 | + 1. Remove half your mods |
| 43 | +
|
| 44 | + 2. Test if the issue still occurs |
| 45 | +
|
| 46 | + 3. If yes, remove half again. If no, restore the last removed half and repeat from step 1. |
| 47 | +
|
| 48 | + 4. Repeat until only the necessary mods remain |
| 49 | + placeholder: "- ModernFix 5.x.x\n- SomeMod 1.2.3" |
| 50 | + validations: |
| 51 | + required: true |
33 | 52 | - type: textarea |
34 | 53 | id: description-reproduction-steps |
35 | 54 | attributes: |
36 | 55 | label: Reproduction Steps |
37 | 56 | description: >- |
38 | | - Provide as much information as possible on how to reproduce this bug. Make sure your instructions are as clear and |
39 | | - concise as possible, because other people will need to be able to follow your guide in order to re-create the issue. |
40 | | - |
41 | | - **Hint:** A common way to fill this section out is to write a step-by-step guide. |
| 57 | + Provide clear steps to reproduce the bug. Each step should be a single concrete action. |
| 58 | +
|
| 59 | + Maintainers are busy and need to be able to quickly replicate your problem. Your reproduction steps should be |
| 60 | + clear enough for someone who is unfamiliar with your mods to follow in 5 minutes or less (not counting time |
| 61 | + to launch the game). |
| 62 | +
|
| 63 | + Providing vague steps is likely to result in the issue being closed. |
| 64 | +
|
| 65 | + placeholder: "1. \n2. \n3. " |
42 | 66 | validations: |
43 | 67 | required: true |
44 | 68 | - type: textarea |
45 | | - id: log-file |
| 69 | + id: diagnostic-info |
46 | 70 | attributes: |
47 | | - label: Log File |
| 71 | + label: Diagnostic Info |
48 | 72 | description: >- |
49 | | - **Hint:** You can usually find the log files within the folder `.minecraft/logs`. Most often, you will want the `latest.log` |
50 | | - file, since that file belongs to the last played session of the game. |
51 | | - placeholder: >- |
52 | | - Drag-and-drop the log file here. |
| 73 | + Drag and drop `latest.log` from `.minecraft/logs/` for the session where the issue occurred. |
| 74 | + Do not paste log text inline. Issues without a valid `latest.log` will be closed. |
| 75 | +
|
| 76 | + If a crash occurred, also attach the relevant file from `.minecraft/crash-reports/`. |
53 | 77 | validations: |
54 | 78 | required: true |
0 commit comments