From e227f50470726a93e347422a0eeaca57d24ec18d Mon Sep 17 00:00:00 2001 From: TropheusJ <60247969+TropheusJ@users.noreply.github.com> Date: Tue, 6 Aug 2024 14:39:14 -0400 Subject: [PATCH] Redo issue templates (#5669) * new issue templates * add MC version to crash * make MC version required * update suggestions * questions link * simpler language * remove minecraft version labeler * change some more words * recommend joining discord before reporting a bug * make debug info optional * typo, say to not upload log contents. remove minecraft version from crash * Tweak some descriptions --------- Co-authored-by: PepperCode1 <44146161+PepperCode1@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug.yml | 41 +++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 155 -------------------------- .github/ISSUE_TEMPLATE/config.yml | 11 ++ .github/ISSUE_TEMPLATE/crash.yml | 27 +++++ .github/ISSUE_TEMPLATE/suggestion.yml | 25 ----- .github/config/labels.yml | 12 -- .github/workflows/label_issues.yml | 15 --- 7 files changed, 79 insertions(+), 207 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/label_issues.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..2bca6f5e2 --- /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 Create." +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 Create!" diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index ade86dc99..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,155 +0,0 @@ -name: Bug Report -description: Create a bug report to help us improve Create -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 occured. You can upload the crash report to a site like Pastebin or GitHub Gist. 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 occured - placeholder: Windows 11 - validations: - required: true - - type: dropdown - attributes: - label: Mod Version - description: The version of the mod you were using when the bug occured - 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" - - "0.4.1" - - "0.4.0f" - - "0.4.0e" - - "0.4.0d" - - "0.4.0c" - - "0.4.0b" - - "0.4.0a" - - "0.4.0" - - "0.3.2g" - - "0.3.2f" - - "0.3.2e" - - "0.3.2d" - - "0.3.2c" - - "0.3.2b" - - "0.3.2a" - - "0.3.2" - - "0.3.1c" - - "0.3.1b" - - "0.3.1a" - - "0.3.1" - - "0.3.0e" - - "0.3.0d" - - "0.3.0c" - - "0.3.0b" - - "0.3.0a" - - "0.3.0" - - "0.2.4e" - - "0.2.4d" - - "0.2.4c" - - "0.2.4b" - - "0.2.4a" - - "0.2.4" - - "0.2.3" - - "0.2.2b" - - "0.2.2a" - - "0.2.2" - - "0.2.1" - - "0.2.0" - - "0.1.1a" - - "0.1.1" - - "0.1.0" - - "0.0.5" - - "0.0.4" - - "0.0.3" - - "0.0.2" - - "0.0.1" - validations: - required: true - - type: dropdown - attributes: - label: Minecraft Version - description: The version of Minecraft you were using when the bug occured - options: - - "1.20.1" - - "1.19.2" - - "1.18.2" - - "1.18.1" - - "1.18" - - "1.17.1" - - "1.16.5" - - "1.16.4" - - "1.16.3" - - "1.15.2" - - "1.14.4" - validations: - required: true - - type: input - attributes: - label: Forge Version - description: The version of Forge you were using when the bug occured - placeholder: 36.2.0 - 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 help improve Create!" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..c9c7595f4 --- /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/hmaD7Se + about: Join us on Discord and ask the community. + - name: I have a suggestion or idea! + url: https://discord.gg/hmaD7Se + about: These are best discussed with the community and submitted on Discord. + - name: Talk to us on Discord. + url: https://discord.gg/hmaD7Se + 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..a5d70e2c5 --- /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 Create!" diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml deleted file mode 100644 index ff5acdb33..000000000 --- a/.github/ISSUE_TEMPLATE/suggestion.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: Suggestion -description: Suggest something that would improve Create -labels: [ "type: suggestion" ] -body: - - type: textarea - attributes: - label: Describe the Suggestion - description: What should we add or change to make Create 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 help improve Create!" diff --git a/.github/config/labels.yml b/.github/config/labels.yml deleted file mode 100644 index 29e1fdc47..000000000 --- a/.github/config/labels.yml +++ /dev/null @@ -1,12 +0,0 @@ -'version: 1.14': - - '1\.14(?:\.\d)?' -'version: 1.15': - - '1\.15(?:\.\d)?' -'version: 1.16': - - '1\.16(?:\.\d)?' -'version: 1.17': - - '1\.17(?:\.\d)?' -'version: 1.18': - - '1\.18(?:\.\d)?' -'version: 1.19': - - '1\.19(?:\.\d)?' diff --git a/.github/workflows/label_issues.yml b/.github/workflows/label_issues.yml deleted file mode 100644 index 02ae70908..000000000 --- a/.github/workflows/label_issues.yml +++ /dev/null @@ -1,15 +0,0 @@ -name: "Label Issues" -on: - issues: - types: [opened, edited] - -jobs: - label: - runs-on: ubuntu-latest - steps: - - uses: github/issue-labeler@v3.0 - with: - configuration-path: .github/config/labels.yml - enable-versioned-regex: 0 - repo-token: ${{ secrets.GITHUB_TOKEN }} - sync-labels: 1