From 227e1fee07f4262e646ab7d275d1252f1f5c724f Mon Sep 17 00:00:00 2001 From: Riley Park Date: Sun, 17 Nov 2024 10:26:31 -0800 Subject: [PATCH] chore: refactor issue templates --- ...ibility.yml => bug-or-incompatibility.yml} | 32 +++++------ .github/ISSUE_TEMPLATE/config.yml | 15 +++--- ...stacktrace.yml => crash-or-stacktrace.yml} | 32 +++++------ .github/ISSUE_TEMPLATE/new-feature.yml | 53 +++++++++++++++++++ .../ISSUE_TEMPLATE/performance-problem.yml | 33 +++++++----- 5 files changed, 113 insertions(+), 52 deletions(-) rename .github/ISSUE_TEMPLATE/{behavior-bug-or-plugin-incompatibility.yml => bug-or-incompatibility.yml} (78%) rename .github/ISSUE_TEMPLATE/{server-crash-or-stacktrace.yml => crash-or-stacktrace.yml} (94%) create mode 100644 .github/ISSUE_TEMPLATE/new-feature.yml diff --git a/.github/ISSUE_TEMPLATE/behavior-bug-or-plugin-incompatibility.yml b/.github/ISSUE_TEMPLATE/bug-or-incompatibility.yml similarity index 78% rename from .github/ISSUE_TEMPLATE/behavior-bug-or-plugin-incompatibility.yml rename to .github/ISSUE_TEMPLATE/bug-or-incompatibility.yml index 00db8a9bbe..5f25e871c9 100644 --- a/.github/ISSUE_TEMPLATE/behavior-bug-or-plugin-incompatibility.yml +++ b/.github/ISSUE_TEMPLATE/bug-or-incompatibility.yml @@ -1,7 +1,21 @@ -name: Behavior Bug or Plugin Incompatibility -description: Report issues with plugin incompatbility or other behavior related issues. -labels: [ "status: needs triage", "type: bug" ] +name: "🐛 Bug or Incompatibility" +description: Report issues related to unexpected behavior or vanilla/plugin incompatibility. +type: "Bug" +labels: + - "status: needs triage" body: + - type: markdown + attributes: + value: | + Before submitting this issue, please ensure the following: + + 1. You are using the latest version of Paper, available on our [our downloads page](https://papermc.io/downloads/paper). + 2. You have searched to confirm there isn’t [an existing open issue](https://github.com/PaperMC/Paper/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug) on this topic. + 3. Your version of Minecraft is supported by Paper. + + If you're unsure whether you've encountered a bug, feel free to ask in the `#paper-help` channel on our + [Discord](https://discord.gg/papermc). + - type: textarea attributes: label: Expected behavior @@ -63,15 +77,3 @@ body: validations: required: false - - type: markdown - attributes: - value: | - Before submitting this issue, please ensure the following: - - 1. You are running the latest version of Paper from [our downloads page](https://papermc.io/downloads/paper). - 2. You searched for and ensured there isn't already an open issue regarding this. - 3. Your version of Minecraft is supported by Paper. - - If you think you have a bug but are not sure, feel free to ask the `#paper-help` channel of our - [Discord](https://discord.gg/papermc). - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7a0a8bbc92..7cf5bb011b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,13 +1,10 @@ blank_issues_enabled: false contact_links: - - name: Feature Request - url: https://github.com/PaperMC/Paper/discussions/new?category=ideas - about: Suggest an idea for Paper - - name: PaperMC Discord - url: https://discord.gg/papermc - about: If you are having issues with spark or have other minor issues, come ask us on our Discord server! - - name: Exploit Report + - name: "❗Exploits" url: https://discord.gg/papermc about: | - Due to GitHub not currently allowing private issues, exploit reports are currently handled via our Discord. - To report an exploit, see the #paper-exploit-report channel. + Since GitHub doesn’t currently support private issues, exploit reports are managed through our Discord. + To report an exploit, please visit the #paper-exploit-report channel. + - name: "🗨 Questions" + url: https://discord.gg/papermc + about: If you have questions or need help with any minor issues, feel free to ask us on our Discord server! diff --git a/.github/ISSUE_TEMPLATE/server-crash-or-stacktrace.yml b/.github/ISSUE_TEMPLATE/crash-or-stacktrace.yml similarity index 94% rename from .github/ISSUE_TEMPLATE/server-crash-or-stacktrace.yml rename to .github/ISSUE_TEMPLATE/crash-or-stacktrace.yml index 056630c593..d0d036b17a 100644 --- a/.github/ISSUE_TEMPLATE/server-crash-or-stacktrace.yml +++ b/.github/ISSUE_TEMPLATE/crash-or-stacktrace.yml @@ -1,7 +1,21 @@ -name: Server crash or Stacktrace -description: Report server crashes or scary stacktraces -labels: [ "status: needs triage" ] +name: "💥 Crash or Stacktrace" +description: Report any server crashes or alarming stack traces. +type: "Bug" +labels: + - "status: needs triage" body: + - type: markdown + attributes: + value: | + Before submitting this issue, please ensure the following: + + 1. You are running the latest version of Paper from [our downloads page](https://papermc.io/downloads/paper). + 2. Your version of Minecraft is supported by Paper. + + If your server crash log contains `DO NOT REPORT THIS TO PAPER`, please ask in our + [Discord](https://discord.gg/papermc) before opening this issue. These messages are informing you of server + lag and providing debug information. + - type: textarea attributes: label: Stack trace @@ -62,15 +76,3 @@ body: 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 this issue, please ensure the following: - - 1. You are running the latest version of Paper from [our downloads page](https://papermc.io/downloads/paper). - 2. Your version of Minecraft is supported by Paper. - - If your server crash log contains `DO NOT REPORT THIS TO PAPER`, please ask in our - [Discord](https://discord.gg/papermc) before opening this issue. These messages are informing you of server - lag and providing debug information. diff --git a/.github/ISSUE_TEMPLATE/new-feature.yml b/.github/ISSUE_TEMPLATE/new-feature.yml new file mode 100644 index 0000000000..731b4a2f53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-feature.yml @@ -0,0 +1,53 @@ +name: "💡 New Feature" +description: Propose a new idea for Paper. +type: "Feature" +labels: + - "status: needs triage" +body: + - type: markdown + attributes: + value: | + Thank you for submitting a feature request for Paper! Please be as detailed as possible to help us review and consider your request effectively. + Before submitting, please ensure the following: + + 1. You are using a supported version of Paper. + 2. The feature you’re requesting isn’t already included in the version you’re using. + 3. You’ve searched for and confirmed there isn’t already [an open request](https://github.com/PaperMC/Paper/issues?q=is%3Aissue%20is%3Aopen%20type%3AFeature) for this feature. + - If a similar request exists, feel free to add any additional details you think are helpful. + + If you have any questions, feel free to ask in the `#paper-help` or `#paper-dev` channels on our [Discord](https://discord.gg/papermc). + + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: Please provide 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: A clear and concise description of what you want. + validations: + required: true + + - type: textarea + attributes: + label: Describe alternatives you've considered. + description: List any alternatives you might have tried to get the feature you want. + validations: + required: true + + - type: textarea + attributes: + label: Other + description: Add any other context or screenshots about the feature request below. + validations: + required: false + + - type: markdown + attributes: + value: | + Before submitting this feature request, please search our issue tracker to ensure your feature has not + already been requested. + diff --git a/.github/ISSUE_TEMPLATE/performance-problem.yml b/.github/ISSUE_TEMPLATE/performance-problem.yml index 12308be9a6..e353ce351e 100644 --- a/.github/ISSUE_TEMPLATE/performance-problem.yml +++ b/.github/ISSUE_TEMPLATE/performance-problem.yml @@ -1,7 +1,19 @@ -name: Performance Problem -description: Report performance related problems or other areas of concern -labels: [ "status: needs triage", "type: performance" ] +name: "🐌 Performance Problem" +description: Report any performance issues. +type: "Bug" +labels: + - "scope: performance" + - "status: needs triage" body: + - type: markdown + attributes: + value: | + Before submitting this issue, please ensure the following: + + 1. You are running the latest version of Paper from [our downloads page](https://papermc.io/downloads/paper). + 2. You searched for and ensured there isn't already [an open issue](https://github.com/PaperMC/Paper/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug) regarding this. + 3. Your version of Minecraft is supported by Paper. + - type: markdown attributes: value: | @@ -10,8 +22,11 @@ body: - type: input attributes: - label: Profile link - description: We ask that all profiles are a link, not a screenshot. Screenshots inhibit our ability to figure out the real cause of the issue. + label: Spark Profile + description: | + Please provide all profiles as links rather than screenshots. Screenshots limit our ability to investigate the root cause of the issue. + + For more information, see our [profiling documentation](https://docs.papermc.io/paper/profiling). placeholder: "Example: https://spark.lucko.me/XsN0hxGfsi" validations: required: true @@ -74,11 +89,3 @@ body: 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 this issue, please ensure the following: - - 1. You are running the latest version of Paper from [our downloads page](https://papermc.io/downloads/paper). - 2. You searched for and ensured there isn't already an open issue regarding this. - 3. Your version of Minecraft is supported by Paper.