diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..e3cb66c7b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: TFG-NewHorizons-1.12.2 Discord + url: https://discord.gg/7TZBSXzPZC + about: Join us on Discord to discuss questions, bugs, and more. diff --git a/.github/ISSUE_TEMPLATE/en-00-crash-report.yml b/.github/ISSUE_TEMPLATE/en-00-crash-report.yml new file mode 100644 index 000000000..6813d1275 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/en-00-crash-report.yml @@ -0,0 +1,78 @@ +name: "[EN] Crash Report" +description: Report a bug that crashes the game or prevents startup. +labels: [ "status: unverified", "type: сrash" ] +body: + - type: input + id: version + attributes: + label: Modpack Used + description: Modpack type and version used when this error was encountered. + placeholder: "Example: TFG:NH v4.1.4" + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional mods + description: The mods and their respective versions used when this bug was encountered. If you were not using mods, please leave this field blank. + placeholder: "Example: Xaero's Minimap v1.1.3" + validations: + required: false + - type: input + id: environment + 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" + validations: + required: true + - type: dropdown + id: crash + attributes: + label: Side Crashed + description: Where the game crashed. + options: + - "Client" + - "Server" + - "Client and Server" + - "Unsure" + validations: + required: true + - type: dropdown + id: world + attributes: + label: New Worlds + description: Does this crash occur on a newly generated world? + options: + - "Yes" + - "No" + - "Unsure" + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: How to reproduce the crash. + placeholder: "Example: 1) I did X..." + validations: + required: true + - type: textarea + id: crash-report + attributes: + label: Crash Report + description: "You can find the crash report in `installation/crash-reports/`, if one was created. Additionally, please attach `installation/logs/latest.log`. If either or both files do not exist, state such. Please link to a paste site with their content, such as GitHub Gists or Pastebin. **Do not paste the contents of either these files directly into the text box.**" + placeholder: "Example: a link to a paste site with the crash report and latest.log." + validations: + required: true + - type: textarea + id: additional-info + 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 caused by X because..." + validations: + required: false + - type: markdown + attributes: + value: Thank you for taking the time to fill out this crash report. diff --git a/.github/ISSUE_TEMPLATE/en-01-bug-report.yml b/.github/ISSUE_TEMPLATE/en-01-bug-report.yml new file mode 100644 index 000000000..e10852830 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/en-01-bug-report.yml @@ -0,0 +1,85 @@ +name: "[EN] Bug report" +description: Report a bug where something is not working as expected, which does not crash the game. +labels: [ "status: unverified", "type: bug" ] +body: + - type: input + id: modpack + attributes: + label: Modpack Used + description: Modpack type and version used when this error was encountered. + placeholder: "Example: TFG:NH v4.1.4" + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional mods + description: The mods and their respective versions used when this bug was encountered. If you were not using mods, please leave this field blank. + placeholder: "Example: Xaero's Minimap v1.1.3" + validations: + required: false + - type: input + id: environment + 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" + validations: + required: true + - type: dropdown + id: world + attributes: + label: New Worlds + description: Does this bug occur on a newly generated world? + options: + - "Yes" + - "No" + - "Unsure" + validations: + required: true + - type: dropdown + id: cross-mod + attributes: + label: Cross-Mod Interaction + description: Is this error caused by another mod installed with the standard modpack? + options: + - "Yes" + - "No" + - "Unsure" + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What you expected to happen. Attach screenshots here as necessary. + placeholder: "Example: Expected to produce X by consuming Y." + validations: + required: true + - type: textarea + id: result + attributes: + label: Actual Behavior + description: What happened despite your expectations. Attach screenshots here as necessary. + placeholder: "Example: Produced one X but Y was not consumed." + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: How to reproduce the bug. + placeholder: "Example: 1) I did X..." + validations: + required: true + - type: textarea + id: additional-info + 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 caused by X because..." + validations: + required: false + - type: markdown + attributes: + value: Thank you for taking the time to fill out this bug report. diff --git a/.github/ISSUE_TEMPLATE/en-02-feature-request.yml b/.github/ISSUE_TEMPLATE/en-02-feature-request.yml new file mode 100644 index 000000000..0b9b71f6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/en-02-feature-request.yml @@ -0,0 +1,39 @@ +name: "[EN] Request a Feature" +description: Request a new feature or a change to an existing one. +labels: [ "type: feature" ] +body: + - type: input + id: version + attributes: + label: Modpack Used + description: Modpack type and version used when this error was encountered. + placeholder: "Example: TFG:NH v4.1.4" + validations: + required: true + - type: textarea + id: problem + 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..." + validations: + required: false + - type: textarea + id: solution + attributes: + label: Your Solution + description: Describe the solution you would like to have happen. + placeholder: "Example: If I could..." + validations: + required: true + - type: textarea + id: additional-info + 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..." + validations: + required: false + - type: markdown + attributes: + value: Thank you for taking the time to fill out this feature request. diff --git a/.github/ISSUE_TEMPLATE/en-03-question.yml b/.github/ISSUE_TEMPLATE/en-03-question.yml new file mode 100644 index 000000000..8e04de803 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/en-03-question.yml @@ -0,0 +1,21 @@ +name: "[EN] Ask a Question" +description: Ask a question regarding this project. +labels: [ "type: question" ] +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 looking for a gameplay wiki, we currently do not have one, 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. + - type: textarea + id: question + attributes: + label: Your Question + description: Feel free to ask any question regarding this project here. + placeholder: "Example: How can I...?" + validations: + required: true + - type: markdown + attributes: + value: Thank you for taking the time to ask us a question. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..1252e1248 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,18 @@ +## What +_This section describes what this PR is about. It should be a clear and concise description concerning what this PR is for, why this PR is needed, and why it should be accepted._ +_Linking an issue can be used alternatively to writing a description._ + +## Implementation Details +_Any implementations in this PR that should be carefully looked over, or that could/should have alternate solutions proposed._ + +## Outcome +_A short description of what this PR added/fixed/changed/removed._ +_For correct linking of issues please use any of the Closes/Fixes/Resolves keywords. Example: When a PR is fixing a bug use "Fixes: #number-of-bug"_ + +## Additional Information +_This section is for screenshots, or any other additional information that reviewers should be aware of._ + +## Potential Compatibility Issues +_This section is for defining possible compatibility issues._ + +**Please fill in as much useful information as possible. Also, please remove all unused sections, including this and the other explanations.**