From 40c95d6635b2060dbc9f6e07875a26e6317a5e8f Mon Sep 17 00:00:00 2001 From: Redeix Date: Fri, 30 Jan 2026 16:59:37 -0600 Subject: [PATCH] Github Issue Templates --- .github/ISSUE_TEMPLATE/BUG_REPORT.yml | 50 +++++++++++++--- .github/ISSUE_TEMPLATE/CRASH_REPORT.yml | 66 +++++++++++++++++++--- .github/ISSUE_TEMPLATE/ENHANCEMENT.yml | 16 +++--- .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml | 60 ++++++++++---------- .github/ISSUE_TEMPLATE/QUESTION.yml | 10 +++- 5 files changed, 145 insertions(+), 57 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml index a0514eeeb..e344af4a1 100644 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.yml @@ -1,5 +1,5 @@ name: "[🐛]: Bug report" -description: "Report a bug where something is not working as expected, which does not crash the game." +description: "Report a bug where something is not working as expected, but does not crash the game." title: "[🐛]: " labels: [ "Status: Backlog" ] projects: ["TerraFirmaGreg-Team/10"] @@ -10,28 +10,62 @@ body: id: exists attributes: label: "Was this bug reported before?" - description: "Please search open/closed issues before submitting, as the issue may have already been reported/addressed." + description: "Please search OPEN/CLOSED issues before submitting, as the issue may have already been reported/addressed." options: - label: "No, it was not." required: true + - type: checkboxes + id: launcher + attributes: + label: "Are you using Prism or Curseforge?" + description: "Prism and Curseforge are the only supported launchers for TFG. Some others may not work. TLAUNCHER DOES NOT WORK." + options: + - label: "Yes, I am using Prism or Curseforge." + required: true + + - type: checkboxes + id: redownload + attributes: + label: "Have you tried redownloading the pack?" + description: "For issues that you are experiencing singularly, redownloading the pack may fix the issue." + options: + - label: "NA/ Yes, I have tried downloading a new instance." + required: true + + - type: input + id: os + validations: + required: true + attributes: + label: Computer OS + description: Write which OS your PC is running on. + placeholder: "Example: Windows 10" + - type: input id: version validations: required: true attributes: - label: "Version modpack used" - description: "Write which version of the modpack you are using." + label: Modpack Version Used + description: Write which version of the modpack you are using. placeholder: "Example: 0.1.1" - - type: input + - type: dropdown id: environment validations: required: true attributes: - label: Environment - description: "How you were playing on the world. Typical answers include: Singleplayer, Open to LAN, Forge Server, Sponge Server, or Mohist Server." - placeholder: "Example: Singleplayer" + label: MC Environment + options: + - "Singleplayer" + - "LAN" + - "Forge Server" + - "Sponge Server" + - "Mohist Server" + - "E4MC" + - "Essential" + - "Other" - type: dropdown id: world diff --git a/.github/ISSUE_TEMPLATE/CRASH_REPORT.yml b/.github/ISSUE_TEMPLATE/CRASH_REPORT.yml index 6520e1409..63846842d 100644 --- a/.github/ISSUE_TEMPLATE/CRASH_REPORT.yml +++ b/.github/ISSUE_TEMPLATE/CRASH_REPORT.yml @@ -9,29 +9,81 @@ body: - type: checkboxes id: exists attributes: - label: "Was this crash report before?" - description: "Please search open/closed issues before submitting, as the issue may have already been reported/addressed." + label: "Was this bug reported before?" + description: "Please search OPEN/CLOSED issues before submitting, as the issue may have already been reported/addressed." options: - label: "No, it was not." required: true + - type: checkboxes + id: launcher + attributes: + label: "Are you using Prism or Curseforge?" + description: "Prism and Curseforge are the only supported launchers for TFG. Some others may not work. TLAUNCHER DOES NOT WORK." + options: + - label: "Yes, I am using Prism or Curseforge." + required: true + + - type: checkboxes + id: dependencies + attributes: + label: "Did you install required dependencies?" + description: "If you are using Prism or Modrinth you will be instructed to install required mods. Do so." + options: + - label: "NA/ Yes, I have all required dependencies installed." + required: true + + - type: checkboxes + id: linuxmoment + attributes: + label: "For Arch Linix users: Do you have the OpenAL audio library installed?" + description: "If you are on Arch Linux you need to have the OpenAL audio library installed." + options: + - label: "NA/ Yes, I have OpenAL." + required: true + + - type: checkboxes + id: redownload + attributes: + label: "Have you tried redownloading the pack?" + description: "For issues that you are experiencing singularly, redownloading the pack may fix the issue." + options: + - label: "NA/ Yes, I have tried downloading a new instance." + required: true + + - type: input + id: os + validations: + required: true + attributes: + label: Computer OS + description: Write which OS your PC is running on. + placeholder: "Example: Windows 10" + - type: input id: version validations: required: true attributes: - label: Version modpack used + label: Modpack Version Used description: Write which version of the modpack you are using. placeholder: "Example: 0.1.1" - - type: input + - type: dropdown id: environment validations: required: true attributes: - label: Environment - description: "How you were playing on the world. Typical answers include: Singleplayer, Open to LAN, Forge Server, Sponge Server, or Mohist Server." - placeholder: "Example: Singleplayer" + label: MC Environment + options: + - "Singleplayer" + - "LAN" + - "Forge Server" + - "Sponge Server" + - "Mohist Server" + - "E4MC" + - "Essential" + - "Other" - type: dropdown id: crash diff --git a/.github/ISSUE_TEMPLATE/ENHANCEMENT.yml b/.github/ISSUE_TEMPLATE/ENHANCEMENT.yml index 2e4288bc9..d643411f4 100644 --- a/.github/ISSUE_TEMPLATE/ENHANCEMENT.yml +++ b/.github/ISSUE_TEMPLATE/ENHANCEMENT.yml @@ -1,6 +1,6 @@ -name: "[🪡]: Enhancement" -description: "Provide supporting details for a feature in development" -title: "[🪡]: " +name: "[💡]: Enhancement" +description: "Provide details for a gameplay enhancement or improvement." +title: "[💡]: " labels: [ "Status: Backlog" ] projects: ["TerraFirmaGreg-Team/10"] type: "Enhancement" @@ -9,8 +9,8 @@ body: - type: checkboxes id: exists attributes: - label: "Was this enhancement asked before?" - description: "Please search open/closed issues before submitting, as the issue may have already been reported/addressed." + label: "Was this enhancement suggested before?" + description: "Please search OPEN/CLOSED issues before submitting, as the enhancement may have already been reported/addressed." options: - label: "No, it was not." required: true @@ -20,8 +20,8 @@ body: validations: required: true attributes: - label: What would you like to be added? - description: Feature requests are unlikely to make progress as issues. + label: What would you like to be added/ changed? + description: Enhancement requests should focus on gameplay improvements or additions that can be achieved without completely new features. Ex. Rebalancing the energy cost of a recipe. - type: textarea id: rationale @@ -32,4 +32,4 @@ body: - type: markdown attributes: - value: "Thanks for taking the time to fill out this request enhancement." \ No newline at end of file + value: "Thanks for taking the time to fill out this enhancement request." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml index a73f7aa56..2728a3b53 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml @@ -1,6 +1,6 @@ -name: "[🪶]: Feature request" -description: "Request a new feature or a change to an existing one." -title: "[🪶]: " +name: "[💎]: Feature request" +description: "Request a new feature or a new mod." +title: "[💎]: " labels: [ "Status: Backlog" ] projects: ["TerraFirmaGreg-Team/10"] type: "Feature" @@ -10,46 +10,44 @@ body: id: exists attributes: label: "Was this feature suggested before?" - description: "Please search open/closed issues before submitting, as the issue may have already been reported/addressed." + description: "Please search OPEN/CLOSED issues before submitting, as the feature may have already been reported/addressed." options: - label: "No, it was not." required: true - - type: input - id: version + - type: checkboxes + id: blacklist + attributes: + label: "A list of popular features/mods the team has already considered and will not implement." + description: | + "### Mod Requests:" + "- Other large tech mods (Immersive Engineering, Mekanism, etc.) will not be added to the pack due to overlap with Gregtech." + "- Magic mods (Thaumcraft, Botania, etc.) will not be added to the pack as we wish to be grounded in plausibility." + "- Create: the factory must grow. And other large Create mods. They do not work with Greate and we do not wish to focus on Create too much." + "- Create Clockworks & Valkyrian Skies. both cool mods, but impossible to balance in TFG." + "- Stargate. Overdone in GT packs. We will work on something unique as an endgame goal." + + "### Feature Requests:" + "- Dyson Spheres. Boring and overdone." + "- More GT Voltage Tiers. We would prefer to have larger more rounded tiers than many small ones." + options: + - label: "I understand :(" + required: true + + - type: textarea + id: feature validations: required: true attributes: - label: "Version modpack used" - description: Write which version of the modpack you are using. - placeholder: "Example: 0.1.1" + label: What would you like to be added? + description: Feature requests should focus on new gameplay experiences or QoL additions. - type: textarea - id: problem - validations: - required: false - attributes: - label: "Related problem" - description: If the feature you wish to change is related to a problem, please desscribe it. Leave this field blank if it is not related to a problem. - placeholder: "Example: I'm always frustrated when..." - - - type: textarea - id: solution + id: rationale validations: required: true attributes: - label: "Your solution" - description: Describe the solution you would like to have happen. - placeholder: "Example: If I could..." - - - type: textarea - id: additional-info - validations: - required: false - attributes: - label: "Additional information" - description: Any additional information you wish to provide. Please add anything which did not fit into the other sections here. - placeholder: "Example: This is likely achieveable by doing X because..." + label: Why is this needed? - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/QUESTION.yml b/.github/ISSUE_TEMPLATE/QUESTION.yml index ba1b89c57..908cdee05 100644 --- a/.github/ISSUE_TEMPLATE/QUESTION.yml +++ b/.github/ISSUE_TEMPLATE/QUESTION.yml @@ -9,7 +9,7 @@ body: id: exists attributes: label: "Was this question asked before?" - description: "Please search open/closed issues before submitting, as the issue may have already been reported/addressed." + description: "Please search OPEN/CLOSED issues before submitting, as the issue may have already been reported/addressed." options: - label: "No, it was not." required: true @@ -17,9 +17,13 @@ body: - type: markdown attributes: value: | - If you are in need of quick response, Discord may be a better place. You can find a link to join in our README.md for this project. + "If you are in need of quick response, [Discord](https://discord.gg/AEaCzCTUwQ) may be a better place." - If you are looking for a game wiki, we are currently developing it, however most information is available in-game info through tooltips, JEI/HEI and quest. You can also ask any question on Discord, and someone will most likely have a response. + "Most information is available in-game through Tooltips, EMI, Field Guide, or Quests." + "An online version of the [Field Guide](https://terrafirmagreg-team.github.io/Field-Guide-Modern/en_us/) is also available." + + "For installing a development environment, please refer to the [Contributing Guide](https://github.com/TerraFirmaGreg-Team/Modpack-Modern/blob/dev/.github/CONTRIBUTING.md)" + "For information about translating please read our [Localization Guide](https://github.com/TerraFirmaGreg-Team/Modpack-Modern/blob/dev/kubejs/README_IF_TRANSLATING.md)" - type: textarea id: question