From 0a601dbc284d71b3c920e6b58d0c501243cef36a Mon Sep 17 00:00:00 2001 From: JOO200 Date: Thu, 25 Nov 2021 21:59:46 +0100 Subject: [PATCH] Improved Bug Report and Feature Request Template --- .github/ISSUE_TEMPLATE/bug_report.md | 34 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 93 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 35 ++++++++ 4 files changed, 128 insertions(+), 54 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 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 a97854a8..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Report a way in which WorldGuard is not working as intended -title: '' -labels: type:bug, status:pending -assignees: '' - ---- - -**Versions** - -WorldEdit version: - -WorldGuard version: - -Platform version: - - -**Describe the bug** - - -**To Reproduce** - -1. ... -2. ... - -**Expected behavior** - - -**Screenshots** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..64821d3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,93 @@ +name: Bug report +description: Report a way in which WorldGuard is not working as intended +labels: ['type:bug', 'status:pending'] + +body: +- type: markdown + attributes: + value: | + Please note that this is only for bugs, help with installation or other types of support should + be taken to the Discord Guild instead. + +- type: input + attributes: + label: WorldEdit Version + description: The full version of WorldEdit, can be found by using `/we version`. + placeholder: e.g. 7.2.3 or 7.3.0-SNAPSHOT + validations: + required: true + +- type: input + attributes: + label: WorldGuard Version + description: The full version of WorldGuard, can be found by using `/wg version`. + placeholder: e.g. 7.0.5 or 7.0.6-SNAPSHOT + validations: + required: true + +- type: input + attributes: + label: WorldGuard Version + description: | + The version of the platform you are on, i.e. Spigot or Paper. + Please ensure you are running up-to-date software before making a bug report. + Old versions, paper forks or hybrids will receive little to no support. + placeholder: e.g. git-Spigot-21fe707-e1ebe52, git-Paper-463 + validations: + required: true + +- type: checkboxes + id: confirmations + attributes: + label: Confirmations + description: Please confirm the following before submitting the bug. Your report will be closed if you are running hybrids or old software. + options: + - label: I am using the most recent Minecraft release. + required: true + - label: I am using a version of WorldEdit compatible with my Minecraft version. + required: true + - label: I am using a version of WorldGuard compatible with my Minecraft version. + required: true + - label: I am using the latest or recommended version of my platform software. + required: true + - label: I am NOT using a hybrid server, e.g. a server that combines Bukkit and Forge. Examples include Arclight, Mohist, and Cardboard. + required: true + - label: I am NOT using a fork of WorldEdit, such as FastAsyncWorldEdit (FAWE) or AsyncWorldEdit (AWE) + required: true + +- type: textarea + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + validations: + required: true + +- type: textarea + attributes: + label: Expected Behavior + description: The behavior that you expected, instead of the bugged behavior that occurs. + validations: + required: true + +- type: textarea + attributes: + label: Reproduction Steps + description: Steps to reproduce the behavior. + value: | + 1. ... + 2. ... + validations: + required: true + + +- type: input + attributes: + label: Optional WorldGuard-Report + description: Link to WorldGuard Region report for bugs with regions, received with `/wg report -p` + validations: + required: false + +- type: textarea + attributes: + label: Anything Else? + description: Add any additional context you can provide below. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index cc299107..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for WorldGuard -title: '' -labels: type:feature-request, status:pending -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** - - -**Describe the solution you'd like** - - -**Describe alternatives you've considered** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..0a1cafda --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,35 @@ +name: Feature request +description: Suggest an idea for WorldGuard +labels: ['type:feature-request', 'status:pending'] + +body: +- type: textarea + attributes: + label: The Problem + description: > + What is making your WorldGuard experience sub-optimal? This should be something that + cannot be easily solved by existing WorldGuard features. + placeholder: It's hard to ... ; I'm unable to ... + validations: + required: true + +- type: textarea + attributes: + label: A Solution + description: What is your proposed solution to the above problem? + validations: + required: true + +- type: textarea + attributes: + label: Alternatives + description: | + Alternative solutions or workarounds to the problem. + You should also describe why these are not preferable to the given solution. + validations: + required: false + +- type: textarea + attributes: + label: Anything Else? + description: Add any additional context you can provide below.