|
1 | 1 | name: Bug Report |
2 | | -description: "For reporting either bugs or crashes" |
| 2 | +description: "For reporting bugs and other defects" |
3 | 3 | labels: |
4 | 4 | - S-needs-triage |
5 | 5 | body: |
6 | 6 | - type: markdown |
7 | 7 | attributes: |
8 | | - value: >- |
9 | | - Before opening an issue, please make sure you have done the following: |
10 | | -
|
11 | | - - **Have you read the [list of known issues](https://github.com/CaffeineMC/sodium-fabric/wiki/Driver-Compatibility)?** Most problems |
12 | | - (such as poor performance) are caused by out-of-date or incompatible graphics drivers. |
| 8 | + value: >- |
| 9 | + **Note: This issue tracker is not intended for support requests!** If you need help with crashes or other issues, then |
| 10 | + you should [ask on our Discord server](https://caffeinemc.net/discord) instead. Unless you are certain that you |
| 11 | + have found a defect, and you are able to point to where the problem is, you should not open an issue. |
13 | 12 | |
14 | | - - **Have you used the [search tool](https://github.com/CaffeineMC/sodium-fabric/issues) to see if someone has already |
15 | | - reported this problem?** If there is already an issue which describes your problem exactly, you should prefer to |
16 | | - add information to that issue, rather than open a new one. |
| 13 | + Additionally, please make sure you have done the following: |
17 | 14 | |
18 | 15 | - **Have you ensured that all of your mods (including Sodium) are up-to-date?** The latest version of Sodium |
19 | 16 | can always be found [on Modrinth](https://modrinth.com/mod/sodium). |
20 | 17 | |
21 | | - - **If the issue occurs only with other mods installed, have you determined which mods exactly are causing the problem?** Please do not |
22 | | - provide your entire mod list and expect us to be able to find which mods are causing the problem. You may try using |
23 | | - a _binary search_ (also known as "divide and conquer") to figure out which mods are problematic. |
| 18 | + - **Have you read the [list of known driver incompatibilities](https://github.com/CaffeineMC/sodium-fabric/wiki/Driver-Compatibility)?** Most problems |
| 19 | + (including "poor performance") are caused by out-of-date or incompatible graphics drivers. |
| 20 | + |
| 21 | + - **Have you used the [search tool](https://github.com/CaffeineMC/sodium-fabric/issues) to check whether your issue |
| 22 | + has already been reported?** If it has been, then consider adding more information to the existing issue instead. |
| 23 | + |
| 24 | + - **Have you determined the minimum set of instructions to reproduce the issue?** If your problem only occurs |
| 25 | + with other mods installed, then you should narrow down exactly which mods are causing the issue. Please do not |
| 26 | + provide your entire list of mods to us and expect that we will be able to figure out the problem. |
24 | 27 | - type: textarea |
25 | 28 | id: description |
26 | 29 | attributes: |
@@ -48,22 +51,25 @@ body: |
48 | 51 | attributes: |
49 | 52 | label: Log File |
50 | 53 | description: >- |
51 | | - Attach the most recent log file from your client (`logs/latest.log`). This file should always be present. |
| 54 | + You can usually find the log files within the folder `.minecraft/logs`. Most often, you will want the `latest.log` |
| 55 | + file, since that file belongs to the last played session of the game. |
52 | 56 | placeholder: >- |
53 | | - Upload the log file here... |
| 57 | + Drag-and-drop the log file here (as a file.) Please do not copy the contents of the log file into this area, or |
| 58 | + otherwise use a third-party service to upload the file. |
54 | 59 | validations: |
55 | 60 | required: true |
56 | 61 | - type: textarea |
57 | 62 | id: crash-report-file |
58 | 63 | attributes: |
59 | 64 | label: Crash Report |
60 | 65 | description: >- |
61 | | - Attach the most recent crash report from the `crash-reports` folder. This is different from the log file above, and it contains |
62 | | - important information about your hardware and software configuration. |
63 | | - |
64 | | - **Important:** If your game is not crashing as a result of your problem, then you need to obtain a crash report manually. This can be done |
65 | | - by loading the game to the main menu, and holding the F3+C keys together for approximately 10 seconds. |
| 66 | + **Important:** Even if your game is _not crashing_ as a result of your problem, we still need a crash report. This |
| 67 | + file contains important information about your hardware and software configuration. You can generate a crash report |
| 68 | + manually by loading the game to the main menu, and holding the F3+C keys together for approximately 10 seconds. |
| 69 | + |
| 70 | + You can usually find crash reports (with their date and time) in the folder `.minecraft/crash-reports`. |
66 | 71 | placeholder: >- |
67 | | - Upload the crash report file here... |
| 72 | + Drag-and-drop the crash report here (as a file.) Please do not copy the contents of the log file into this area, or |
| 73 | + otherwise use a third-party service to upload the file. |
68 | 74 | validations: |
69 | 75 | required: true |
0 commit comments