diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 45b5f5c7..22a25ebf 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,7 @@ name: Bug Report description: "Report some other kind of issue." -labels: [ "bug" ] +labels: [ "Type: Bug" ] +type: "Bug" body: - type: textarea attributes: @@ -14,10 +15,10 @@ body: - type: input attributes: - label: Game Log & Crash Report (if applicable) + label: Game Log (if applicable) description: > - We may need the game/crash log for additional information. - This file can be found in the \"logs\" or \"crash-reports\" folder of your Minecraft folder as \"latest.log\" or \"crash-*.txt"\. + We may need the game log for additional information. + This file can be found in the \"logs\" folder of your Minecraft folder as \"latest.log\". Please upload the file to https://mclo.gs/ and put the link here. **DO NOT** paste the file or its raw here, as that makes it harder to examine, and reduces the chance that we will be able to help you. validations: @@ -30,6 +31,7 @@ body: Please run the \"/create debuginfo\" command in-game. This will copy useful information to your clipboard that will greatly help with debugging. Please paste this information here. + **This is required and needed for debugging, so please don't leave this empty or add something else!** validations: required: true diff --git a/.github/ISSUE_TEMPLATE/compat_report.yml b/.github/ISSUE_TEMPLATE/compat_report.yml new file mode 100644 index 00000000..0b14b343 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/compat_report.yml @@ -0,0 +1,40 @@ +name: Bug Report +description: "Report some other kind of incompatibility with another mod." +labels: [ "Type: Compatibility" ] +type: "Bug" +body: + - type: textarea + attributes: + label: Description + description: > + Please describe the issue in as much detail as possible. + Explain what happened, and what you expected to have happened instead. + Include images, screenshots, or videos if applicable. + validations: + required: true + + - type: input + attributes: + label: Game Log (if applicable) + description: > + We may need the game log for additional information. + This file can be found in the \"logs\" folder of your Minecraft folder as \"latest.log\". + Please upload the file to https://mclo.gs/ and put the link here. + **DO NOT** paste the file or its raw here, as that makes it harder to examine, and reduces the chance that we will be able to help you. + validations: + required: false + + - type: textarea + attributes: + label: Debug Information + description: > + Please run the \"/create debuginfo\" command in-game. + This will copy useful information to your clipboard that will greatly help with debugging. + Please paste this information here. + **This is required and needed for debugging, so please don't leave this empty or add something else!** + validations: + required: true + + - type: markdown + attributes: + value: "Thank you for taking the time to make a report and help improve Create: Sound of Steam!" diff --git a/.github/ISSUE_TEMPLATE/crash_report.yml b/.github/ISSUE_TEMPLATE/crash_report.yml new file mode 100644 index 00000000..550dd288 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash_report.yml @@ -0,0 +1,40 @@ +name: Bug Report +description: "Report a crash." +labels: [ "Type: Crash" ] +type: "Bug" +body: + - type: textarea + attributes: + label: Description + description: > + Please describe the crash in as much detail as possible. + Include images, screenshots, or videos if applicable. + validations: + required: true + + - type: input + attributes: + label: Crash Report + description: > + We may need the crash report for additional information. + This file can be found in the \"crash-reports\" folder of your Minecraft folder as \"crash-*.txt"\. + Please upload the file to https://mclo.gs/ and put the link here. + **DO NOT** paste the file or its raw here, as that makes it harder to examine, and reduces the chance that we will be able to help you. + validations: + required: true + + - type: textarea + attributes: + label: Debug Information + description: > + If possible please run the \"/create debuginfo\" command in-game. + This will copy useful information to your clipboard that will greatly help with debugging. + Please paste this information here. + + If that is not possible, please shortly describe which version you are using, which addons and on what operating system you are etc. + validations: + required: true + + - type: markdown + attributes: + value: "Thank you for taking the time to make a report and help improve Create: Sound of Steam!" diff --git a/.github/ISSUE_TEMPLATE/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml new file mode 100644 index 00000000..54fafff4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -0,0 +1,41 @@ +name: Feature request +description: "Suggest an idea/change for the documentation" +labels: [ "Type: Documentation" ] +type: "Feature" +body: + - type: textarea + attributes: + label: Which page would you like to have added to/changed? + description: > + Please describe what you want to be added/changed. + validations: + required: true + + + - type: textarea + attributes: + label: "Describe the solution you'd like." + description: > + A clear and concise description of what you want to happen. + 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: textarea + attributes: + label: Additional context + description: > + Add any other context or screenshots about the feature request here. + validations: + required: false + + - type: markdown + attributes: + value: "Thank you for taking the time to make a report and help improve Create: Sound of Steam!" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 073f1753..dc88b1b8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,12 +1,19 @@ name: Feature request description: "Suggest an idea for the mod" -labels: [ "enhancement" ] +labels: [ "Type: Enhancement" ] +type: "Feature" body: + - - type: textarea + - attributes: + - label: What feature do you want to be added? + - description: > + Please describe what you want to be added. + - type: textarea attributes: label: Is your feature request related to a problem? Please describe. description: > - A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]. Leave empty if not. + A clear and concise description of what the problem is. e.g. \"I'm always frustrated when [...].\" Leave empty if not. validations: required: false @@ -24,7 +31,7 @@ body: description: > A clear and concise description of any alternative solutions or features you've considered. validations: - required: true + required: false - type: textarea attributes: