diff --git a/.github/ISSUE_TEMPLATE/1-bug.md b/.github/ISSUE_TEMPLATE/1-bug.md deleted file mode 100644 index 6fe45e9b..00000000 --- a/.github/ISSUE_TEMPLATE/1-bug.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: 🐞 Bug report -about: Report a bug or some unexpected behavior. -labels: Bug ---- - - -### Description - - - -### How to reproduce - - - -### Platform - -- Server version (output of `/version`): -- Holographic Displays version (check with `/hd`): -- ProtocolLib version, if installed (check with `/protocol version`): -- Do you use plugins to allow players to join with multiple Minecraft versions (such as ViaVersion, ProtocolSupport, ...): - - -### Additional context - diff --git a/.github/ISSUE_TEMPLATE/1-bug.yml b/.github/ISSUE_TEMPLATE/1-bug.yml new file mode 100644 index 00000000..19470bbe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.yml @@ -0,0 +1,79 @@ +name: 🐞 Bug Report +description: "Report a bug or some unexpected behavior." +labels: + - "Bug" +body: + - type: markdown + attributes: + value: |- + Please fill this form carefully and provide the requested details. Thank you for contributing to the project. + + - type: checkboxes + attributes: + label: "Confirmation" + description: "Please confirm to have done the following checks before opening a new issue." + options: + - label: "I have read the [FAQ](https://filoghost.me/docs/holographic-displays/faq)." + required: true + - label: "I have tested the [latest development build](https://ci.codemc.io/job/filoghost/job/HolographicDisplays) of Holographic Displays and the bug is still present." + required: true + - label: "I have updated **Spigot** (and **ProtocolLib** if installed) to the latest release for my particular Minecraft version." + required: true + - label: "I made sure the bug hasn't already been reported on the [issue tracker](https://github.com/filoghost/HolographicDisplays/issues?q=is%3Aissue)." + required: true + + - type: textarea + attributes: + label: "Description" + description: |- + Clear and concise description of the bug. + **Avoid long error logs**, add them in the "Addition information" area at the bottom of this form. + placeholder: "What happened? What did you expect to happen instead?" + validations: + required: true + + - type: textarea + attributes: + label: "How to reproduce" + description: "List of steps to reproduce the bug." + placeholder: |- + 1. Step 1 + 2. Step 2 + 3. ... + validations: + required: true + + - type: input + attributes: + label: "Server version" + description: "Output of the command `/version`." + placeholder: "This server is running CraftBukkit version 3132-Spigot-66f9d3c-40caacc (MC: 1.17) (Implementing API version 1.17-R0.1-SNAPSHOT)" + validations: + required: true + + - type: input + attributes: + label: "Holographic Displays version" + description: "Output of the command `/version HolographicDisplays`." + placeholder: "HolographicDisplays version 2.4.8-SNAPSHOT-b174" + validations: + required: true + + - type: input + attributes: + label: "ProtocolLib version (if installed)" + description: "Output of the command `/version ProtocolLib`." + placeholder: "ProtocolLib version 4.6.0-SNAPSHOT-b476" + + - type: input + attributes: + label: "Installed plugins that allow players to join with multiple Minecraft versions" + description: "List plugins such as ViaVersion, ViaBackwards, ProtocolSupport that you're using (if any)." + placeholder: "ViaVersion, ViaBackwards" + + - type: textarea + attributes: + label: Additional information + description: |- + Relevant attachments such as **screenshots**, **server logs**, **configurations files** or any other additional information that might be useful. + Text files can also be uploaded to [Pastebin](https://pastebin.com) and shared through the generated link. diff --git a/.github/ISSUE_TEMPLATE/2-feature.md b/.github/ISSUE_TEMPLATE/2-feature.md deleted file mode 100644 index 161bf4c3..00000000 --- a/.github/ISSUE_TEMPLATE/2-feature.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: 💡 Suggestion -about: "Suggest a new feature or an improvement. ⚠ Note: suggestions have low priority, I will answer them only if possible." -labels: Enhancement ---- - - -### Description - diff --git a/.github/ISSUE_TEMPLATE/2-feature.yml b/.github/ISSUE_TEMPLATE/2-feature.yml new file mode 100644 index 00000000..bb357512 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature.yml @@ -0,0 +1,16 @@ +name: 💡 Suggestion +description: "Suggest a new feature or an improvement." +labels: + - "Enhancement" +body: + - type: markdown + attributes: + value: |- + Please suggest changes that would benefit as many users as possible, not just specific situations. Thank you for contributing to the project. + + - type: textarea + attributes: + label: "Description" + description: "Describe the new feature or improvement." + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/3-help.md b/.github/ISSUE_TEMPLATE/3-help.md deleted file mode 100644 index 61060c93..00000000 --- a/.github/ISSUE_TEMPLATE/3-help.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: 📝 Help request -about: "Ask a question about the plugin. ⚠ Note: help requests have low priority, I will answer them only if possible." -labels: Help ---- - - -### What are you trying to do? - - - -### What have you tried so far? - - - -### Platform - -- Server version (output of `/version`): -- Holographic Displays version (check with `/hd`): -- ProtocolLib version, if installed (check with `/protocol version`): -- Do you use plugins to allow players to join with multiple Minecraft versions (such as ViaVersion, ProtocolSupport, ...): - - -### Additional context - diff --git a/.github/ISSUE_TEMPLATE/3-help.yml b/.github/ISSUE_TEMPLATE/3-help.yml new file mode 100644 index 00000000..4efa7861 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-help.yml @@ -0,0 +1,42 @@ +name: 📝 Help request +description: "Ask a question." +labels: + - "Help" +body: + - type: markdown + attributes: + value: |- + Please make sure you are using a recent version of the plugin. + + - type: checkboxes + attributes: + label: "Confirmation" + description: "Please confirm to have done the following checks before opening a new issue." + options: + - label: "I have read the [documentation](https://filoghost.me/docs/holographic-displays)." + required: true + - label: "I have read the [FAQ](https://filoghost.me/docs/holographic-displays/faq)." + required: true + + - type: textarea + attributes: + label: "Description" + description: "Describe your goal and what you have tried so far." + placeholder: "What are you trying to achieve? What have you tried so far?" + validations: + required: true + + - type: input + attributes: + label: "Holographic Displays version" + description: "Output of the command `/version HolographicDisplays`." + placeholder: "HolographicDisplays version 2.4.8-SNAPSHOT-b174" + validations: + required: true + + - type: textarea + attributes: + label: Additional information + description: |- + Relevant attachments such as **screenshots**, **server logs**, **configurations files** or any other additional information that might be useful. + Text files can also be uploaded to [Pastebin](https://pastebin.com) and shared through the generated link. diff --git a/.github/ISSUE_TEMPLATE/4-documentation.md b/.github/ISSUE_TEMPLATE/4-documentation.md deleted file mode 100644 index d132bafc..00000000 --- a/.github/ISSUE_TEMPLATE/4-documentation.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: 📚 Documentation improvement -about: "Request an improvement for the official documention." -labels: Documentation ---- - - -### Description - diff --git a/.github/ISSUE_TEMPLATE/4-documentation.yml b/.github/ISSUE_TEMPLATE/4-documentation.yml new file mode 100644 index 00000000..ce42d658 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4-documentation.yml @@ -0,0 +1,16 @@ +name: 📚 Documentation improvement +description: "Suggest a change or report an error to improve the official documentation." +labels: + - "Documentation" +body: + - type: markdown + attributes: + value: |- + Suggest a change or report an error to improve the official documentation. Thank you for contributing to the project. + + - type: textarea + attributes: + label: "Description" + description: "Describe what should be improved and, if possible, _how_." + validations: + required: true diff --git a/.github/issue-close-app.yml b/.github/issue-close-app.yml deleted file mode 100644 index fb41e4c8..00000000 --- a/.github/issue-close-app.yml +++ /dev/null @@ -1,33 +0,0 @@ -comment: >- - This issue has been automatically closed because it doesn't follow the issue template. - - - Please open a new issue and make sure to **follow the provided template**, - fill out the sections **without modifying** or **deleting** the existing text. - - - Templates are necessary to manage the project efficiently, - as basic questions don't need to be asked again each time. - -issueConfigs: - -# Bug -- content: - - "# Description" - - "# How to reproduce" - - "# Platform" - -# Feature / Documentation -- content: - - "# Description" - -# Help -- content: - - "# What are you trying to do" - - "# What have you tried so far" - - "# Platform" - -caseInsensitive: true -label: "Closed by bot" -exception: - - "filoghost"