From 9ba39a5c6c130fc91111758d6326a535d24ce065 Mon Sep 17 00:00:00 2001 From: Manuel Sabogal Date: Tue, 29 Oct 2024 19:47:15 +0100 Subject: [PATCH] Update Bug Report to use issue forms --- .github/ISSUE_TEMPLATE/bug_report.md | 37 --------------- .github/ISSUE_TEMPLATE/bug_report.yml | 66 +++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 37 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c76e79e..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**Mod Loader** - - [ ] Forge - - [ ] NeoForge - - [ ] Fabric - -**Version Info (Please complete the following information)** - - Mod Loader: [e.g. 51.0.22] - - SkinChanger Version: [e.g. 0.6.1] - - Minecraft Version: [e.g. 1.21.0] - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Logs** -Add logs to help explain your problem. You can find them inside the logs folder of your Minecraft instance. - -**Screenshots** -If applicable, add screenshots to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..fa21b99 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,66 @@ +name: Bug Report +description: "For reporting bugs and other defects" +labels: + - "needs-triage" +body: + - type: markdown + attributes: + value: >- + # READ THIS BEFORE YOU POST AN ISSUE! + + - **Have you ensured that the mod is up-to-date?** The latest version of SkinChanger can always be found + [on Modrinth](https://modrinth.com/mod/SkinChanger). + + - **Have you used the [search tool](https://github.com/edoren/SkinChanger/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. + - 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 + - type: textarea + id: crash-report-file + attributes: + label: Crash Report + description: >- + **Important:** Even if your game is _not crashing_ as a result of your problem, we still need a crash report. This + file contains important information about your hardware and software configuration. You can generate a crash report + manually by loading the game to the main menu, and holding the F3+C keys together for approximately 10 seconds. + + **Hint:** You can usually find crash reports (with their date and time) in the folder `.minecraft/crash-reports`. + placeholder: >- + Drag-and-drop the crash report file here. + validations: + required: true