From 051d489a952e535ad52dfde197fc90e2cb6598c9 Mon Sep 17 00:00:00 2001 From: powercas_gamer Date: Thu, 30 Mar 2023 21:53:49 +0200 Subject: [PATCH] [ci skip] add issue templates (#15) * [ci skip] add issue templates * mention paper plugins might not work * change name * typo --- .github/ISSUE_TEMPLATE/behavior-bug.yml | 76 +++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 +++ .github/ISSUE_TEMPLATE/feature-request.yml | 44 ++++++++++ .../ISSUE_TEMPLATE/performance-problems.yml | 84 +++++++++++++++++++ .../server-crash-or-stacktrace.yml | 76 +++++++++++++++++ 5 files changed, 290 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/behavior-bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/performance-problems.yml create mode 100644 .github/ISSUE_TEMPLATE/server-crash-or-stacktrace.yml diff --git a/.github/ISSUE_TEMPLATE/behavior-bug.yml b/.github/ISSUE_TEMPLATE/behavior-bug.yml new file mode 100644 index 0000000..80465e5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/behavior-bug.yml @@ -0,0 +1,76 @@ +name: Behavior Bug +description: Report behavior related issues, where Folia does not work like vanilla. Paper and Bukkit plugins are not guaranteed to work on Folia. Do not submit bug reports for plugin issues here. +labels: [ "status: needs triage", "type: bug" ] +body: + - type: textarea + attributes: + label: Expected behavior + description: What you expected to see. + validations: + required: true + + - type: textarea + attributes: + label: Observed/Actual behavior + description: What you actually saw. + validations: + required: true + + - type: textarea + attributes: + label: Steps/models to reproduce + description: This may include a build schematic, a video, or detailed instructions to help reconstruct the issue. + validations: + required: true + + - type: textarea + attributes: + label: Plugin and Datapack List + description: | + All plugins and datapacks running on your server. + To list plugins, run `/plugins`. For datapacks, run `/datapack list`. + validations: + required: true + + - type: textarea + attributes: + label: Folia version + description: | + Run `/version` on your server and **paste** the full, unmodified output here. + "latest" is *not* a version; we require the output of `/version` so we can adequately track down the issue. + Additionally, do NOT provide a screenshot, you MUST paste the entire output. +
+ Example + + ``` + > version + [10:00:11 INFO]: Checking version, please wait... + [10:00:12 INFO]: This server is running Folia version git-Folia-"5b74945" (MC: 1.19.4) (Implementing API version 1.19.4-R0.1-SNAPSHOT) (Git: 5b74945) + You are running the latest version + Previous version: git-Paper-481 (MC: 1.19.4) + ``` + +
+ validations: + required: true + + - type: textarea + attributes: + label: Other + description: | + Please include other helpful information 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 this issue, please ensure the following: + + 1. You are running the latest version of Folia from [our downloads page](https://papermc.io/downloads). + 2. You searched for and ensured there isn't already an open issue regarding this. + 3. Your version of Minecraft is supported by Folia. + + If you think you have a bug but are not sure, feel free to ask the `#folia-help` channel of our + [Discord](https://discord.gg/papermc). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..b723d47 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +blank_issues_enabled: false +contact_links: + - name: PaperMC Discord + url: https://discord.gg/papermc + about: If you are having minor issues, come ask us on our Discord server! + - name: Exploit Report + 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. \ 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 0000000..b1284fd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,44 @@ +name: Feature Request +description: Suggest an idea for Folia +labels: [ "status: needs triage", "type: feature" ] +body: + - type: markdown + attributes: + value: | + Thank you for filling out a feature request for Folia! Please be as detailed as possible so that we may consider and review the request easier. + We ask that you search all the issues to avoid a duplicate feature request. If one exists, please reply if you have anything to add. + Before requesting a new feature, please make sure you are using the latest version and that the feature you are requesting is not already in Folia. + + - 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: 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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/performance-problems.yml b/.github/ISSUE_TEMPLATE/performance-problems.yml new file mode 100644 index 0000000..42ba14f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/performance-problems.yml @@ -0,0 +1,84 @@ +name: Performance Problem +description: Report performance related problems or other areas of concern +labels: [ "status: needs triage", "type: performance" ] +body: + - type: markdown + attributes: + value: | + Before creating an issue regarding server performance, please consider reaching out for support in the + `#folia-help` channel of [our Discord](https://discord.gg/papermc)! + + - 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. + placeholder: "Example: https://spark.lucko.me/abcdefg12h" + validations: + required: true + + - type: textarea + attributes: + label: Description of issue + description: If applicable, please describe your issue. + validations: + required: false + + - type: textarea + attributes: + label: Plugin and Datapack List + description: | + All plugins and datapacks running on your server. + To list plugins, run `/plugins`. For datapacks, run `/datapack list`. + validations: + required: true + + - type: textarea + attributes: + label: Server config files + description: We need bukkit.yml, spigot.yml, paper-global.yml, paper-world-defaults.yml and server.properties. If you use per-world Paper configs, make sure to include them. You can paste it below or use a paste site like https://paste.gg. + value: | + ``` + Paste configs or paste.gg link here! + ``` + placeholder: Please don't remove the backticks; it makes your issue a lot harder to read! + validations: + required: true + + - type: textarea + attributes: + label: Folia version + description: | + Run `/version` on your server and **paste** the full, unmodified output here. + "latest" is *not* a version; we require the output of `/version` so we can adequately track down the issue. + Additionally, do NOT provide a screenshot, you MUST paste the entire output. +
+ Example + + ``` + > version + [10:00:11 INFO]: Checking version, please wait... + [10:00:12 INFO]: This server is running Folia version git-Folia-"5b74945" (MC: 1.19.4) (Implementing API version 1.19.4-R0.1-SNAPSHOT) (Git: 5b74945) + You are running the latest version + Previous version: git-Paper-481 (MC: 1.19.4) + ``` + +
+ validations: + required: true + + - 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 this issue, please ensure the following: + + 1. You are running the latest version of Folia from [our downloads page](https://papermc.io/downloads). + 2. You searched for and ensured there isn't already an open issue regarding this. + 3. Your version of Minecraft is supported by Folia. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/server-crash-or-stacktrace.yml b/.github/ISSUE_TEMPLATE/server-crash-or-stacktrace.yml new file mode 100644 index 0000000..7816e0a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/server-crash-or-stacktrace.yml @@ -0,0 +1,76 @@ +name: Server crash or Stacktrace +description: Report server crashes or scary stacktraces +labels: [ "status: needs triage" ] +body: + - type: textarea + attributes: + label: Stack trace + description: | + We need all of the stack trace! Do not cut off parts of it. Please do not use attachments. + If you prefer, you can use a paste site like https://paste.gg. + value: | + ``` + paste your stack trace or a paste.gg link here! + ``` + placeholder: Please don't remove the backticks; it makes your issue a lot harder to read! + validations: + required: true + + - type: textarea + attributes: + label: Plugin and Datapack List + description: | + All plugins and datapacks running on your server. + To list plugins, run `/plugins`. For datapacks, run `/datapack list`. + validations: + required: true + + - type: textarea + attributes: + label: Actions to reproduce (if known) + description: This may include a build schematic, a video, or detailed instructions to help reconstruct the issue. Anything helps! + validations: + required: false + + - type: textarea + attributes: + label: Folia version + description: | + Run `/version` on your server and **paste** the full, unmodified output here. + "latest" is *not* a version; we require the output of `/version` so we can adequately track down the issue. + Additionally, do NOT provide a screenshot, you MUST paste the entire output. +
+ Example + + ``` + > version + [10:00:11 INFO]: Checking version, please wait... + [10:00:12 INFO]: This server is running Folia version git-Folia-"5b74945" (MC: 1.19.4) (Implementing API version 1.19.4-R0.1-SNAPSHOT) (Git: 5b74945) + You are running the latest version + Previous version: git-Paper-481 (MC: 1.19.4) + ``` + +
+ validations: + required: true + + - type: textarea + attributes: + label: Other + description: | + Please include other helpful information below, if any. + 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 Folia from [our downloads page](https://papermc.io/downloads). + 2. Your version of Minecraft is supported by Folia. + + If your server crash log contains `DO NOT REPORT THIS TO FOLIA`, 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. \ No newline at end of file