From a70073ae3e64ddf77829ada3c05a4c7e3c81554d Mon Sep 17 00:00:00 2001 From: Jason Penilla <11360596+jpenilla@users.noreply.github.com> Date: Tue, 22 Oct 2024 09:21:13 -0700 Subject: [PATCH] Setup issue templates (#53) * Setup issue templates * try to change order --- .github/ISSUE_TEMPLATE/a_incompatibility.yml | 53 ++++++++++++++++ .github/ISSUE_TEMPLATE/b_bug.yml | 55 +++++++++++++++++ .github/ISSUE_TEMPLATE/c_performance.yml | 65 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/d_feature.yml | 34 ++++++++++ 5 files changed, 212 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/a_incompatibility.yml create mode 100644 .github/ISSUE_TEMPLATE/b_bug.yml create mode 100644 .github/ISSUE_TEMPLATE/c_performance.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/d_feature.yml diff --git a/.github/ISSUE_TEMPLATE/a_incompatibility.yml b/.github/ISSUE_TEMPLATE/a_incompatibility.yml new file mode 100644 index 00000000..e847f148 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/a_incompatibility.yml @@ -0,0 +1,53 @@ +name: Mod Incompatibility +description: Report an incompatibility with another mod. +title: '[Incompatibility: ]: Mod Name' +labels: + - mod-incompatibility + - needs-triage +body: + - type: input + id: mc_ver + attributes: + label: Minecraft Version + placeholder: e.g. 1.21.1 or 1.21.2 + validations: + required: true + - type: input + id: moonrise_ver + attributes: + label: Moonrise Version + placeholder: e.g. 0.1.0-beta.6 or Git commit hash + validations: + required: true + - type: dropdown + id: mod_loader + attributes: + label: Mod Loader + description: >- + The mod loader(s) this conflict happens with. When selecting 'Both' it + is expected you will submit logs for both as well. Be sure to update the + issue title. + options: + - NeoForge + - Fabric + - Both (NeoForge and Fabric) + validations: + required: true + - type: textarea + id: logs_crashes + attributes: + label: Logs and Crash Reports + description: >- + Include links to all relevant logs and crash reports (prefer using + https://gist.github.com/ or https://mclo.gs/). In case this is not + applicable fill in 'N/A' (it is expected you will provide context + below). + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional Context + description: Provide any relevant context, including version of the conflicting mod. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/b_bug.yml b/.github/ISSUE_TEMPLATE/b_bug.yml new file mode 100644 index 00000000..a67c80c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/b_bug.yml @@ -0,0 +1,55 @@ +name: Bug Report +description: Report a bug or Vanilla behavior parity issue. +title: '[Bug: ]: Short description' +labels: + - bug + - needs-triage +body: + - type: input + id: mc_ver + attributes: + label: Minecraft Version + placeholder: e.g. 1.21.1 or 1.21.2 + validations: + required: true + - type: input + id: moonrise_ver + attributes: + label: Moonrise Version + placeholder: e.g. 0.1.0-beta.6 or Git commit hash + validations: + required: true + - type: dropdown + id: mod_loader + attributes: + label: Mod Loader + description: >- + The mod loader(s) this bug happens with. When selecting 'Both' it + is expected you will submit logs for both as well. Be sure to update the + issue title. + options: + - NeoForge + - Fabric + - Both (NeoForge and Fabric) + validations: + required: true + - type: textarea + id: logs_crashes + attributes: + label: Logs and Crash Reports + description: >- + Include links to all relevant logs and crash reports (prefer using + https://gist.github.com/ or https://mclo.gs/). In case this is not + applicable fill in 'N/A' (it is expected you will provide context + below). + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional Context + description: >- + Provide any relevant context, including expected vs. actual behavior, + and reproduction steps. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/c_performance.yml b/.github/ISSUE_TEMPLATE/c_performance.yml new file mode 100644 index 00000000..a0cc78c2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/c_performance.yml @@ -0,0 +1,65 @@ +name: Performance Problem +description: Report a performance problem that doesn't fall under the bug category. +title: '[Performance: ]: Short description' +labels: + - performance + - needs-triage +body: + - type: input + id: mc_ver + attributes: + label: Minecraft Version + placeholder: e.g. 1.21.1, 1.21.2 + validations: + required: true + - type: input + id: moonrise_ver + attributes: + label: Moonrise Version + placeholder: e.g. 0.1.0-beta.6 or Git commit hash + validations: + required: true + - type: dropdown + id: mod_loader + attributes: + label: Mod Loader + description: >- + The mod loader(s) this bug happens with. When selecting 'Both' it is + expected you have tested both as well. Be sure to update the issue + title. + options: + - NeoForge + - Fabric + - Both (NeoForge and Fabric) + validations: + required: true + - type: textarea + id: logs_crashes + attributes: + label: Logs and Crash Reports + description: >- + Include links to all relevant logs and crash reports (prefer using + https://gist.github.com/ or https://mclo.gs/). In case this is not + applicable fill in 'N/A' (it is expected you will provide context + below). + validations: + required: true + - type: textarea + id: profiler + attributes: + label: Profiler Data + description: >- + Provide profiler data showing the problem, from Spark or other tools. In + case this is not applicable fill in 'N/A' (it is expected you will + provide context below). + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional Context + description: >- + Provide any relevant context, including reproduction steps, world data, + videos, etc. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..1efdefc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Discord + url: https://discord.gg/tuinity + about: If you are unsure about something or have general questions, ask in our Discord before opening an issue. diff --git a/.github/ISSUE_TEMPLATE/d_feature.yml b/.github/ISSUE_TEMPLATE/d_feature.yml new file mode 100644 index 00000000..564fb29c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/d_feature.yml @@ -0,0 +1,34 @@ +name: Feature Request +description: Request a new feature. +title: '[Feature Request: ]: Short description' +labels: + - enhancement + - needs-triage +body: + - type: input + id: mc_ver + attributes: + label: Minecraft Version + placeholder: e.g. 1.21.1, 1.21.2 + validations: + required: true + - type: dropdown + id: mod_loader + attributes: + label: Mod Loader + description: The mod loader(s) this feature request is relevant for. + options: + - NeoForge + - Fabric + - Both (NeoForge and Fabric) + validations: + required: true + - type: textarea + id: context + attributes: + label: Description + description: >- + Describe the feature request in detail, including alternatives + considered. + validations: + required: true