From dd8ff45b2aaa9cf79fa50411006252bfa164716f Mon Sep 17 00:00:00 2001 From: IThundxr Date: Tue, 6 Aug 2024 16:08:44 -0400 Subject: [PATCH] Update issue templates to match create for a better reporting experience --- .github/ISSUE_TEMPLATE/bug.yml | 41 ++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 133 -------------------------- .github/ISSUE_TEMPLATE/config.yml | 11 +++ .github/ISSUE_TEMPLATE/crash.yml | 27 ++++++ .github/ISSUE_TEMPLATE/suggestion.yml | 25 ----- .github/config/labels.yml | 6 -- .github/workflows/issueLabeler.yml | 14 --- 7 files changed, 79 insertions(+), 178 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/crash.yml delete mode 100644 .github/ISSUE_TEMPLATE/suggestion.yml delete mode 100644 .github/config/labels.yml delete mode 100644 .github/workflows/issueLabeler.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..02a092528 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,41 @@ +name: I found a bug! +description: "Report some other kind of issue. You should ask in the Discord first to make sure it's actually a bug with Steam 'n' Rails." +labels: [ "type: bug" ] +body: + - type: textarea + attributes: + label: Description + description: " + Please describe the issue with as much detail as possible. + Explain what happened, and what should have happened instead. + Add images, screenshots, or videos if they could be useful." + validations: + required: true + + - type: input + attributes: + label: Game Log + description: " + We need the game log for additional information about the bug. + This file can be found in the \"logs\" folder of your Minecraft folder as \"latest.log\". + Please upload the file to https://mclo.gs/ and put the link here. + Do **not** paste the *contents* of the file here, because that will make this issue very hard to read. + " + validations: + required: true + + - type: textarea + attributes: + label: Debug Information + description: " + Please run the \"/create debuginfo\" command in-game. + This will copy useful information to your clipboard that will greatly help with debugging. + Please paste this information here. + If this command does not exist, you can skip this part. + " + validations: + required: false + + - type: markdown + attributes: + value: "Thank you for taking the time to make a report and help improve Steam 'n' Rails!" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 775ea4557..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,133 +0,0 @@ -name: Bug Report -description: Create a bug report to help us improve Steam 'n' Rails -labels: [ "type: bug" ] -body: - - type: textarea - attributes: - label: Describe the Bug - description: A clear and concise description of what the bug is - validations: - required: true - - type: textarea - attributes: - label: Reproduction Steps - description: Tell us about the steps to reproduce the bug. - value: | - 1. - 2. - 3. - ... - validations: - required: true - - type: textarea - attributes: - label: Expected Result - description: A clear and concise description of what you expected to happen - validations: - required: true - - type: textarea - attributes: - label: Screenshots and Videos - description: If applicable, add screenshots or videos to help explain your problem. - validations: - required: false - - type: input - attributes: - label: Crash Report or Log - description: If applicable, please add a **link** to the crash report or log that was created when this issue occurred. You can upload the crash report to a site like [mclogs](https://mclo.gs) or [Pastebin](https://pastebin.com). Please **do not** paste the whole crash report in this issue. - validations: - required: false - - type: input - attributes: - label: Operating System - description: The operating system you were using when the bug occurred - placeholder: Windows 11 - validations: - required: true - - type: dropdown - attributes: - label: Mod Version - description: The version of the mod you were using when the bug occurred - options: - - "1.6.4" - - "1.6.3" - - "1.6.2" - - "1.6.1" - - "1.6.0" - - "1.5.3" - - "1.5.2" - - "1.5.1" - - "1.5.0" - - "1.4.8" - - "1.4.7" - - "1.4.6" - - "1.4.5" - - "1.4.4" - - "1.4.3" - - "1.4.2" - - "1.4.1" - - "1.4.0" - - "1.3.5" - - "1.3.4" - - "1.3.3" - - "1.3.2" - - "1.3.1" - - "1.3.0" - - "1.2.6" - validations: - required: true - - type: dropdown - attributes: - label: Create Mod Version - description: The version of **Create Mod** you were using when the bug occurred - options: - - "0.5.1f" - - "0.5.1e" - - "0.5.1d" - - "0.5.1c" - - "0.5.1b" - - "0.5.1a" - - "0.5.0i" - - "0.5.0h" - - "0.5.0g" - - "0.5.0f" - - "0.5.0e" - - "0.5.0d" - - "0.5.0c" - - "0.5.0b" - - "0.5.0a" - - "0.5.0" - validations: - required: true - - type: dropdown - attributes: - label: Minecraft Version - description: The version of Minecraft you were using when the bug occurred - options: - - "1.20.1" - - "1.19.2" - - "1.18.2" - validations: - required: true - - type: input - attributes: - label: ModLoader and Version - description: The **modloader** and **version** of the modloader using when the bug occurred - placeholder: Fabric 0.14.21 - validations: - required: true - - type: textarea - attributes: - label: Other Mods - description: Please list any other mods that were running when the crash happened. - validations: - required: false - - type: textarea - attributes: - label: Additional Context - description: Add any extra context about the bug here - validations: - required: false - - type: markdown - attributes: - value: "Thank you for taking the time to make this bug report and helping improve Steam 'n' Rails!" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..8d0b844bf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: I have a question! + url: https://discord.gg/create-steam-n-rails-706277846389227612 + about: Join us on Discord and ask the community. + - name: I have a suggestion or idea! + url: https://discord.gg/create-steam-n-rails-706277846389227612 + about: These are best discussed with the community and submitted on Discord. + - name: Talk to us on Discord. + url: https://discord.gg/create-steam-n-rails-706277846389227612 + about: Ask questions and get help from the community. diff --git a/.github/ISSUE_TEMPLATE/crash.yml b/.github/ISSUE_TEMPLATE/crash.yml new file mode 100644 index 000000000..1f9097af7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash.yml @@ -0,0 +1,27 @@ +name: My game crashed! +description: Report an issue that crashes the game. +labels: [ "type: crash" ] +body: + - type: textarea + attributes: + label: Context + description: What were you doing when the game crashed? Add images, screenshots, or videos if they could be useful. + validations: + required: true + + - type: input + attributes: + label: Crash Report + description: " + We need the crash report to figure out why the crash happened. + This file can be found in the \"crash-reports\" folder of your Minecraft folder. + It will be the newest file there. + Please upload the file to https://mclo.gs/ and put the link here. + Do **not** paste the *contents* of the file here, because that will make this issue very hard to read. + " + validations: + required: true + + - type: markdown + attributes: + value: "Thank you for taking the time to make a report and help improve Steam 'n' Rails!" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml deleted file mode 100644 index 33fb22874..000000000 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Suggestion -description: Suggest something that would improve Steam 'n' Rails -labels: [ "type: suggestion" ] -body: - - type: textarea - attributes: - label: Describe the Suggestion - description: What should we add or change to make Steam 'n' Rails better? - validations: - required: true - - type: textarea - attributes: - label: Screenshots and Videos - description: If applicable, add screenshots or videos to help explain your suggestion. - validations: - required: false - - type: textarea - attributes: - label: Additional Context - description: Add any extra context about the suggestion here. - validations: - required: false - - type: markdown - attributes: - value: "Thank you for taking the time to make this suggestion and helping improve Steam 'n' Rails!" \ No newline at end of file diff --git a/.github/config/labels.yml b/.github/config/labels.yml deleted file mode 100644 index 181268cec..000000000 --- a/.github/config/labels.yml +++ /dev/null @@ -1,6 +0,0 @@ -'version: 1.18': - - '1\.18(?:\.\d)?' -'version: 1.19': - - '1\.19(?:\.\d)?' -'version: 1.20': - - '1\.20(?:\.\d)?' \ No newline at end of file diff --git a/.github/workflows/issueLabeler.yml b/.github/workflows/issueLabeler.yml deleted file mode 100644 index e21f67c71..000000000 --- a/.github/workflows/issueLabeler.yml +++ /dev/null @@ -1,14 +0,0 @@ -name: "Label Issues" -on: - issues: - types: [opened, edited] - -jobs: - label: - runs-on: ubuntu-latest - steps: - - uses: github/issue-labeler@v3.4 - with: - configuration-path: .github/config/labels.yml - enable-versioned-regex: 0 - repo-token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file