From 9352ea54f815f3e243d714ed4a279a56e048464e Mon Sep 17 00:00:00 2001 From: KennyTV Date: Mon, 22 Mar 2021 15:34:01 +0100 Subject: [PATCH] Add form based issue templates (cherry picked from commit 6600d78a105eeb3ea685f27e5d059cdc0399fa06) --- .github/ISSUE_TEMPLATE/bug_report.md | 31 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 95 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 37 +++++++++ 4 files changed, 140 insertions(+), 31 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 78f5bfe1..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug report -about: Create a bug report so we can fix it - ---- - -**Describe the bug, provide any errors** -A clear and concise description of what the bug is. Can you https://paste.gg/ the error? - -**How can we reproduce it?** -Steps to reproduce the behavior: -1. Login on 1.12' -2. Click on '....' -3. The '....' is displayed wrong - -**Expected behaviour** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**ViaVersion Dump:** -- Type /viaversion dump, and put the link here. - -**Additional server info** -Do you use a proxy (eg. BungeeCord)? What software do you use and what plugins? - -**Checklist** -- [ ] I have included a ViaVersion dump -- [ ] If applicable, I have included a paste (not a screenshot) of the error -- [ ] I have tried a build from https://ci.viaversion.com/ and the issue still persists \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..c83ba535 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,95 @@ +name: Bug Report +description: Report a bug or console error + +body: + - type: markdown + attributes: + value: "**Before reporting a bug, please see if using master/dev builds from https://ci.viaversion.com/ fixes your issue.**" + + - type: input + attributes: + label: "'/viaversion dump' Output" + description: | + Run `/viaversion dump` in the console or in the chat, then copy and paste the given link here. + placeholder: | + https://dump.viaversion.com/... + validations: + required: true + + - type: textarea + attributes: + label: Console Error + description: | + If you encounter warnings/errors in your console, **paste them with https://paste.gg/ and put the paste link here**. + If the error is small/less than 10 lines, you may put it directly into this field. + value: | + ``` + Put the paste.gg link or text here. + ``` + placeholder: Please do not remove the grave accents; simply replace the line of text in the middle. + validations: + required: false + + - type: textarea + attributes: + label: Bug Description + description: | + Describe the unexpected behavior. + If you want to attach screenshots, use the comment field at the bottom of the page. + placeholder: | + Example: "Placing signs on 1.13.2 causes text to disappear." + validations: + required: true + + - type: textarea + attributes: + label: Steps to Reproduce + description: | + List the steps on how we can reproduce the issue. Make sure we can easily understand what you mean with each step. + placeholder: | + Example: + 1. Login with a 1.13.2 client + 2. Place a sign + 3. The sign text is displayed wrong + validations: + required: true + + - type: textarea + attributes: + label: Expected Behavior + description: | + Describe what exactly you expected to happen. + placeholder: | + Example: "Placed sign text should not disappear." + validations: + required: true + + - type: textarea + attributes: + label: Additional Server Info + description: | + Do you use a proxy (eg. BungeeCord)? What software do you use and what plugins? + placeholder: | + Example: "I also use BungeeCord with the following plugins: x, y, z" + validations: + required: false + + - type: checkboxes + attributes: + label: Checklist + description: Make sure you have followed each of the steps outlined here. + options: + - label: Via plugins are only running on **EITHER** the backend servers (e.g. Paper) **OR** the proxy (e.g. BungeeCord), **not on both**. + required: true + - label: I have included a ViaVersion dump. + required: true + - label: If applicable, I have included a paste (**not a screenshot**) of the error. + required: true + - label: I have tried a build from https://ci.viaversion.com/ and the issue still persists. + required: true + + - type: markdown + attributes: + value: | + ## Comments And Screenshots + If needed, add **screenshots to help explain your problem** in the comment field below. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..30a05744 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Dev builds + url: https://ci.viaversion.com/ + about: Before reporting a bug, please check if using master/dev builds from our ci fixes your issue. + - name: ViaVersion Discord + url: https://discord.gg/viaversion + about: For smaller issues or questions, you can also join our Discord server. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..182d2dd8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: Feature Request +description: Suggest a feature to be added + +body: + - type: textarea + attributes: + label: Problem Description + description: | + Describe the issue you are facing or why you need the feature to be added. + placeholder: | + I am always frustrated with... + validations: + required: true + + - type: textarea + attributes: + label: Solution Description + description: | + Describe the solution you would like to see. + validations: + required: true + + - type: textarea + attributes: + label: Alternatives + description: | + Describe alternatives you have considered. + validations: + required: false + + - type: textarea + attributes: + label: Additional Info + description: | + Does the feature apply to any specific version or environment? + validations: + required: false \ No newline at end of file