Skip to content

Commit

Permalink
GitHub is stupid and has no issue template preview while editing
Browse files Browse the repository at this point in the history
  • Loading branch information
jellysquid3 committed Jul 21, 2023
1 parent 19cd2c1 commit 519c30d
Show file tree
Hide file tree
Showing 5 changed files with 105 additions and 42 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Bug report
description: "Use this template if you're running into bugs or other issues"
description: "Use this template if you're running into bugs or other issues."
labels:
- T-bug
- S-needs-triage
Expand All @@ -9,26 +9,17 @@ body:
value: >-
## Instructions
Before opening an issue, please make sure you have done the following:
This is a template for the issue you are about to open! It will help you
provide the information necessary to complete your **bug report**.
Before you open an issue, ensure you've completed every step on the
checklist below.
- Have you used the [search
tool](https://github.com/CaffeineMC/sodium-fabric/issues) to find
similar issues? If you find one that looks like what you are getting,
consider contributing additional information to it instead. Make sure
you are not opening a duplicate.
- Have you used the [search tool](https://github.com/CaffeineMC/sodium-fabric/issues)
to look for similar issues?
- Are you using the latest version of the mod? If not, try updating to
see if it resolves your issue. You can find the latest versions of
CaffeineMC mods [here](https://caffeinemc.net).
All good? Then continue to fill the issue by providing the following
information about it:
- If the issue occurs only with other mods installed, have you determined
which mods exactly are causing the problem?
- type: input
id: version
attributes:
Expand All @@ -37,7 +28,7 @@ body:
Please provide the exact version of the mod you are using. Every part of
the version is important! If you do not know what version you are using,
look at the file name in your `mods` folder.
placeholder: 'Example: mc1.16.4-0.1.1+rev.4b3964a'
placeholder: 'Example: mc1.19.4-0.4.10'
validations:
required: true
- type: textarea
Expand Down Expand Up @@ -81,12 +72,19 @@ body:
You can obtain this information from the right-side of the in-game debug
screen (F3) or through using
[DxDiag](https://support.microsoft.com/en-us/help/4028644/windows-open-and-run-dxdiagexe)
on Windows.
on Windows. If you are unsure as to how to fill it in, please screenshot dxdiag or the in-game debug screen (F3) and attach to 'Additional Information'.
- type: input
id: java
attributes:
label: Java version
placeholder: 'Example: Java 16'
placeholder: 'Example: OpenJDK Java 17'
validations:
required: true
- type: input
id: os
attributes:
label: Operating system version
placeholder: 'Example: Windows 11 22H2 | Ubuntu 22.04 | MacOS 13'
validations:
required: true
- type: input
Expand All @@ -103,12 +101,19 @@ body:
placeholder: 'Example: Intel HD Graphics 620'
validations:
required: true
- type: input
id: gpu-driver
attributes:
label: Graphics driver version
placeholder: 'Example: Intel HD Graphics 620 31.0.101.2121'
validations:
required: true
- type: textarea
id: additional
attributes:
label: Additional information
description: >-
Provide a list of any other mods you are using, along with their
respective versions. If you have any screenshots, videos, or other
information that you feel is necessary to explain the issue, feel free
to attach them here.
information that you feel is necessary to explain the issue, please
attach them here.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Crash report
description: Use this template if your game is crashing or failing to start correctly
description: "Use this template if your game is crashing or failing to start correctly."
labels:
- T-crash
- S-needs-triage
Expand Down Expand Up @@ -37,7 +37,45 @@ body:
Please provide the exact version of the mod you are using. Every part of
the version is important! If you do not know what version you are using,
look at the file name in your `mods` folder.
placeholder: 'Example: mc1.16.4-0.1.1+rev.4b3964a'
placeholder: 'Example: mc1.19.4-0.4.10'
validations:
required: true
- type: markdown
attributes:
value: >-
# System Information
You can obtain this information from the right-side of the in-game debug
screen (F3) or through using
[DxDiag](https://support.microsoft.com/en-us/help/4028644/windows-open-and-run-dxdiagexe)
on Windows. If you are unsure as to how to fill it in, please screenshot dxdiag or the in-game debug screen (F3) and attach to 'Additional Information'.
- type: input
id: os
attributes:
label: Operating system version
placeholder: 'Example: Windows 11 22H2 | Ubuntu 22.04 | MacOS 13'
validations:
required: true
- type: input
id: cpu
attributes:
label: CPU
placeholder: 'Example: Intel Core i5-7200U'
validations:
required: true
- type: input
id: gpu
attributes:
label: GPU
placeholder: 'Example: Intel HD Graphics 620'
validations:
required: true
- type: input
id: gpu-driver
attributes:
label: Graphics driver version
placeholder: 'Example: Intel HD Graphics 620 31.0.101.2121'
validations:
required: true
- type: textarea
Expand All @@ -61,9 +99,9 @@ body:
attributes:
label: Crash Report file
description: >-
Upload your crash report file as an attachment to this issue (drag-and-drop) or to a service such as GitHub
Gist (paste a link) and replace this section. This information is critical in resolving your issue!
Upload your crash report file as an attachment to this issue (drag-and-drop) or to [GitHub Gist](https://gist.github.com/)
(paste a link) and replace this section. This information is critical in resolving your issue!
Messages like "Exit code 0" from your launcher are not what you're looking for. If your launcher does not
provide a button to view the most recent crash report, check your game's `crash-reports` folder for the most recent
crash report file.
Expand Down
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature request
description: "Suggest an idea for this project."
labels: ["T-enhancement", "S-needs-triage"]
body:
- type: input
attributes:
label: "Is your feature request related to a problem? Please describe."
description: "A clear and concise description of what the problem is."
placeholder: "Ex: I'm always frustrated when [...]"
validations:
required: true
- type: input
attributes:
label: "Describe the solution you'd like."
description: "A clear and concise description of what you want to happen."
validations:
required: true
- type: textarea
attributes:
label: "Describe alternatives you've considered."
description: "A clear description of any alternative solutions or features you've considered."
placeholder: |
1. [...]
2. [...]
3. [...]
- type: textarea
attributes:
label: "Additional context:"
description: "Add any other context or screenshots about the feature request here."


6 changes: 6 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
blank_issues_enabled: true
contact_links:
- name: Join our Discord community.
url: https://caffeinemc.net/discord
about: For help with installation, performance issues, or any other questions/support inquiries.
# Copied from https://github.com/CaffeineMC/sodium-fabric#community
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 519c30d

Please sign in to comment.