From 6ff902b016da7b0150bc4ce80b23b1321c35f8e2 Mon Sep 17 00:00:00 2001 From: Phillipp Glanz <6745190+TheMeinerLP@users.noreply.github.com> Date: Fri, 24 Jan 2025 19:14:44 +0100 Subject: [PATCH] chore: Add issue templates for more structure (#2624) * chore: Add issue templates for more structure * Update .github/ISSUE_TEMPLATE/bug.yml Co-authored-by: Christian Bergschneider * Update .github/ISSUE_TEMPLATE/feature.yml Co-authored-by: Christian Bergschneider * Update .github/ISSUE_TEMPLATE/bug.yml Co-authored-by: Christian Bergschneider * chore: Remove required for code sample and step of reproduce --------- Co-authored-by: Phillipp Glanz <--global> Co-authored-by: Christian Bergschneider --- .github/ISSUE_TEMPLATE/bug.yml | 60 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 +++ .github/ISSUE_TEMPLATE/feature.yml | 33 ++++++++++++++ .github/ISSUE_TEMPLATE/performance.yml | 40 +++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/ISSUE_TEMPLATE/performance.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..4c771e3f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,60 @@ +name: Report a bug +description: You found a bug? Let us know! +title: "[Bug]: " +labels: [ "bug", "needs triage" ] +body: + - type: markdown + attributes: + value: | + Thank you for reporting a bug to Minestom! + Please fill out the information below to help us understand the issue. + - type: markdown + attributes: + value: | + Before filling in the form fields, please consider the following: + - Ensure that you are using the latest version of Minestom. + - Search for existing issues in the [issue tracker](https://github.com/Minestom/Minestom/issues) + - type: textarea + attributes: + label: Affected Version + description: | + The unique version of the used dependency. + It can be found out via the Git class or in the dependency. + validations: + required: true + - type: textarea + attributes: + label: Describe the bug + description: | + A clear and concise description of what the bug is. + If you have a screenshot of the bug, please attach it below. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce the bug + description: Tell us exactly how to reproduce the bug you are experiencing + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: false + - type: textarea + attributes: + label: Code sample + description: | + Please create a reproducible sample to show us the bug in action and attach it below between the lines with the backticks. + This helps us to verify that the bug is valid and prevents us from having to ask you for a sample later. + + Without this we will be unlikely to be able to progress on the issue, so + we'll regretfully have to close it. + + **Note**: Please do not upload screenshots of text. Instead, use code blocks + or the above mentioned ways to upload your code sample. + value: | + ```java + [Paste your code here] + ``` + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..4c6c0a05c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: false +contact_links: + - name: Minestom Discord + url: https://discord.gg/minestom/ + about: Please join our Discord server if you have any questions or concerns. + icon: https://github.com/simple-icons/simple-icons/blob/develop/icons/discord.svg \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..4a34fd4ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,33 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[Feature]: " +labels: [ "enhancement" ] +body: + - type: markdown + attributes: + value: | + Thank you for suggesting an idea to make Minestom better! + Please fill out the information below to help us understand your idea. + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: Please give some context for this request. Why do you want it added? + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like + description: Give us a clear description of what you want + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: markdown + attributes: + value: | + Before submitting your feature request, please make sure you have done the following: + - [ ] Searched for existing feature requests \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/performance.yml b/.github/ISSUE_TEMPLATE/performance.yml new file mode 100644 index 000000000..1391d12b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/performance.yml @@ -0,0 +1,40 @@ +name: Performance Problem +description: Report a performance problem which is related to Minestom +labels: [ "needs triage", "performance" ] +body: + - type: markdown + attributes: + value: | + Before creating an issue regarding to the performance, please reach out for support on our [Discord](https://discord.gg/minestom/) + or in the [Discussions](https://github.com/Minestom/Minestom/discussions)! + + **Please be aware: Performance issues can sometimes depend on your specific implementation and not on Minestom itself. If the situation is clear and it's not a problem with the project, we will close the issue without any comment.** + - type: input + attributes: + label: Used Minestom version + description: Which version of Minestom are you using? + placeholder: 1.0.0 + validations: + required: true + - type: textarea + attributes: + label: Describe the performance problem + description: If applicable, please describe your issue. + validations: + required: false + - type: textarea + attributes: + label: Other + description: | + Please include other helpful links below. + The more information we receive, the quicker and more effective we can be at finding the solution to the issue. + validations: + required: false + - type: markdown + attributes: + value: | + Before submitting your issue, please make sure you have done the following: + + 1. You are running the latest version of Minestom from [Release page](https://github.com/Minestom/Minestom) + 2. You searched for and ensured there isn't already an open issue regarding this + 3. Your version of Minecraft is supported by Minestom \ No newline at end of file