From f60c0165e366ab24a5a6e3748619dee94d1b292f Mon Sep 17 00:00:00 2001 From: KennyTV Date: Mon, 22 Mar 2021 14:34:54 +0100 Subject: [PATCH 1/3] Issue forms, anyone? --- .github/ISSUE_TEMPLATE/bug_report.md | 33 --------- .github/ISSUE_TEMPLATE/bug_report.yml | 89 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 4 + .github/ISSUE_TEMPLATE/feature_request.md | 17 ----- 4 files changed, 93 insertions(+), 50 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index cfffc40be..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Create a bug report so we can fix it - ---- - -*Please fill in this template rather than deleting it* - -**Describe the bug, provide any errors** -A clear and concise description of what the bug is. If present, can you paste the error to https://paste.gg/? - -**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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..d115cce28 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,89 @@ +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. + validations: + required: true + + - type: textarea + attributes: + label: Error + description: | + If you encounter warnings/errors in your console, **paste them under 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: | + A clear and concise description of what the bug is. + placeholder: | + Example: "Placing signs on 1.13.2 causes text to disappear." + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: | + A clear and concise description of how we can reproduce the issue. + 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: | + A clear and concise description of what you expected to happen. + placeholder: | + Example: "Placed sign text should not disappear." + validations: + required: true + + - type: textarea + attributes: + label: Additional server information + 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* my 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: 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 index 3ba13e0ce..2f4ad6c40 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,5 @@ blank_issues_enabled: false +contact_links: + - name: PaperMC 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.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 8bbc2c4fd..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for ViaVersion - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Which versions is this for?** -Does the feature apply to any specific versions? If so put them here. From 2f45de2f6a49662d19bff11cb0ffca6c78206b7e Mon Sep 17 00:00:00 2001 From: KennyTV Date: Mon, 22 Mar 2021 14:42:05 +0100 Subject: [PATCH 2/3] Small changes to the issue form --- .github/ISSUE_TEMPLATE/bug_report.yml | 15 ++++++++------- .github/ISSUE_TEMPLATE/config.yml | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d115cce28..7a4b53dd4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,18 +4,18 @@ 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. + 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" + label: "'/viaversion dump' output" description: Run `/viaversion dump` in the console or in the chat, then copy and paste the given link here. validations: required: true - type: textarea attributes: - label: Error + label: Console error description: | If you encounter warnings/errors in your console, **paste them under 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. @@ -23,7 +23,6 @@ body: ``` 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 @@ -75,15 +74,17 @@ body: label: Checklist description: Make sure you have followed each of the steps outlined here. options: - - label: Via plugins are only running on *either* my backend servers (e.g. Paper) *or* the proxy (e.g. BungeeCord), not on both. + - 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. + - 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: If needed, add **screenshots to help explain your problem** in the comment field below. + value: | + + 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 index 2f4ad6c40..018b18852 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - - name: PaperMC Discord + - 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 From 00b4c9b1f8220ae41363e7b5aae3dd0d6b1f2e12 Mon Sep 17 00:00:00 2001 From: KennyTV Date: Mon, 22 Mar 2021 15:30:33 +0100 Subject: [PATCH 3/3] Add feature request template --- .github/ISSUE_TEMPLATE/bug_report.yml | 35 +++++++++++--------- .github/ISSUE_TEMPLATE/config.yml | 3 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 37 ++++++++++++++++++++++ 3 files changed, 60 insertions(+), 15 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 7a4b53dd4..c83ba5359 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: Bug report +name: Bug Report description: Report a bug or console error body: @@ -8,29 +8,34 @@ body: - 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. + 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 + label: Console Error description: | - If you encounter warnings/errors in your console, **paste them under https://paste.gg/** and put the paste link here. + 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 + label: Bug Description description: | - A clear and concise description of what the bug is. + 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: @@ -38,9 +43,9 @@ body: - type: textarea attributes: - label: Steps to reproduce + label: Steps to Reproduce description: | - A clear and concise description of how we can reproduce the issue. + 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 @@ -51,9 +56,9 @@ body: - type: textarea attributes: - label: Expected behavior + label: Expected Behavior description: | - A clear and concise description of what you expected to happen. + Describe what exactly you expected to happen. placeholder: | Example: "Placed sign text should not disappear." validations: @@ -61,7 +66,7 @@ body: - type: textarea attributes: - label: Additional server information + label: Additional Server Info description: | Do you use a proxy (eg. BungeeCord)? What software do you use and what plugins? placeholder: | @@ -74,11 +79,11 @@ body: 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**. + - 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. + - 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 @@ -86,5 +91,5 @@ body: - 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 index 018b18852..30a057444 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +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 000000000..182d2dd82 --- /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