Skip to content

Commit

Permalink
Added issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
UnlikePaladin committed May 20, 2024
1 parent b17adac commit aa70f09
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Bug Report
description: "For reporting bugs and other defects"
labels:
- bug
body:
- type: markdown
attributes:
value: >-
**Note: This issue tracker is not intended for support requests!** If you need help with crashes or other issues, then
you should [ask on our Discord server](https://discord.figuramc.org/) instead.
<br><br>
Additionally, please make sure you have done the following:
- **Have you ensured that all of your mods are up-to-date?** The latest version of Figura
can always be found [on Modrinth](https://modrinth.com/mod/figura) or [on CurseForge](https://curseforge.com/minecraft/mc-mods/figura).
- **Have you used the [search tool](https://github.com/FiguraMC/Figura/issues) to check whether your issue
has already been reported?** If it has been, then consider adding more information to the existing issue instead.
- **Have you determined the minimum set of instructions to reproduce the issue?** If your problem only occurs
with other mods installed, then you should narrow down exactly which mods are causing the issue. Please do not
provide your entire list of mods to us and expect that we will be able to figure out the problem.
<br>
This issue template was based [off of Sodium's](https://github.com/CaffeineMC/sodium-fabric/blob/dev/.github/ISSUE_TEMPLATE/bug_report.yml)
- type: textarea
id: description
attributes:
label: Bug Description
description: >-
Use this section to describe the issue you are experiencing in as much depth as possible. The description should
explain what behavior you were expecting, and why you believe the issue to be a bug. If the issue you are reporting
only occurs with specific mods installed, then provide the name and version of each mod.
**Hint:** If you have any screenshots, videos, or other information that you feel is necessary to
explain the issue, you can attach them here.
- type: textarea
id: description-reproduction-steps
attributes:
label: Reproduction Steps
description: >-
Provide as much information as possible on how to reproduce this bug. Make sure your instructions are as clear and
concise as possible, because other people will need to be able to follow your guide in order to re-create the issue.
**Hint:** A common way to fill this section out is to write a step-by-step guide.
validations:
required: true
- type: textarea
id: log-file
attributes:
label: Log File
description: >-
**Hint:** You can usually find the log files within the folder `.minecraft/logs`. Most often, you will want the `latest.log`
file, since that file belongs to the last played session of the game.
placeholder: >-
Drag-and-drop the log file here.
validations:
required: true
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
blank_issues_enabled: true
contact_links:
- name: For help with other issues, join the Discord community
url: https://discord.figuramc.org/
about: This is the best option for getting help with mod installation, performance issues, and any other support inquiries
# Copied from https://github.com/CaffeineMC/sodium-fabric#community
# Copied from https://github.com/CaffeineMC/sodium-fabric/blob/dev/.github/ISSUE_TEMPLATE/config.yml
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Feature Request
description: "For requesting new features or improvements"
labels:
- enhancement
body:
- type: markdown
attributes:
value: >-
This form is for requesting new features or improvements, and should not be used for bug reports or other issues.
- type: markdown
attributes:
value: >-
Make sure you have used the [search tool](https://github.com/FiguraMC/Figura/issues) to see if a similar
request already exists. If we have previously closed a feature request, then please do not create another request.
- type: markdown
attributes:
value: >-
This template was based [off of Sodium's](https://github.com/CaffeineMC/sodium-fabric/blob/dev/.github/ISSUE_TEMPLATE/feature_request.yml)
- type: textarea
id: description
attributes:
label: Request Description
description: >-
Use this section to describe the feature or improvement that you are looking for. The description should explain
what you would like to see added, and a clear and concise description
of what you would like changed.

0 comments on commit aa70f09

Please sign in to comment.