TMC/modded7
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 5 Wiki Activity

Improve Issue Templates (#348)

Browse Source 
Used the GTCEu Issue Templates as a base. Thanks to them!

 New Bug Report Template
 New Feature Request Template
 Discord link

/* Commits: */
* Create config.yml

* Update config.yml

* Update bug_report.md

* Update feature_request.md

* Add gtceu's bug report template

* Change reproduction section

* Further improve `how to reproduce` section

* Add markdown information

* Fix bug_report

* Update 001-bug-report.yml

* Update 001-bug-report.yml

* Version field

Goes down to 1.4. Anyone playing versions older than 1.4 is told to update.

* Fix up version entry

* Improve version field description

* Update description & labels

* Delete bug_report.md

* Add changed configs/mod section

* Improve Config/mod section

* Add launcher section

* Add log entry

* Fix 001-bug-report.yml

* Fix 001-bug-report.yml again

* Fix 001-bug-report.yml again... again?

* Add placeholder text for log entry

* Fix small issues in 001-bug-report.yml

* Small fixes in 001-bug-report.yml

* Make log description clearer

* Swap expected and actual behaviour locations

* Add mode input to bug_report

* Fix 001-bug-report.yml

* Create 002-feature-request from gtceu

* Delete feature_request.md

* Rename 002-feature-request to 002-feature-request.yml

* Add version input + markdown note

* Improve markdown note

* Fix 002-feature-request.yml

* Fix 002-feature-request.yml again

* Small fix in 001-bug-report.yml

* Finish off 002-feature-request.yml
This commit is contained in:
IntegerLimit 2023-05-02 16:44:14 +10:00 committed by GitHub
parent 2f1f6d8075
commit b617a81666
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 185 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

111
.github/ISSUE_TEMPLATE/001-bug-report.yml vendored Normal file
View File

@ -0,0 +1,111 @@
name: Bug Report
description: "Crashes or unintended behaviors arising from Nomi CEu's mods, configurations, or custom scripts."
labels: bug
body:
- type: markdown
attributes:
value: "Note: If you need general tech support for things like server configuration, or general game support (how to I make this?), Discord is a better venue. Please open an issue only if there is a clear bug with the pack or if you have been asked to by one of the Discord staff."
- type: dropdown
id: version
attributes:
label: Nomi CEu Version
description: The version of Nomi CEu you were using when this bug was encountered. If you do not know what it is, check the title of your instance window. If you do not see your version here, please update to the newest version of the pack, which currently is 1.6, or the newest alpha/beta, which currently is 1.6.1-alpha-1.
options:
- "1.6.1-alpha-1"
- "1.6"
- "1.5.2"
- "1.5.1"
- "1.5"
- "1.4.3"
- "1.4.2"
- "1.4.1a"
- "1.4"
validations:
required: true
- type: input
id: launcher
attributes:
label: Launcher
description: "What launcher you were using when you experienced this issue. If you were using the CurseForge Launcher, please try to see if the issue occurs on a different launcher."
placeholder: "Example: Prism Launcher"
validations:
required: true
- type: textarea
id: changed
attributes:
label: Configurations or Mods Changed
description: Any changed configs, and removed or added mods. Make sure to also include the version of any mods you have added. If you have not changed any configurations, and not removed or added any mods, please leave this field blank.
placeholder: |
Example:
Changed Loliasm Config: B:onDemandAnimatedTextures to false.
Added AE2 Fluid Crafting Rework: Version 2.4.18-r.
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: mode
attributes:
label: Mode
description: "What pack mode were you using when you came across this error?"
options:
- "Normal Mode"
- "Expert Mode"
- "Both Modes"
- "N/A"
validations:
required: true
- type: textarea
id: problem
attributes:
label: What Happened
description: What happened, of which you believe is a bug. Attach screenshots here as necessary.
placeholder: "Example: Produced one X but Y was not consumed."
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: reproduction
attributes:
label: Reproduction Steps
description: "How do you trigger this bug? Please walk us through it step by step."
placeholder: |
1.
2.
3.
...
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs
description: "If your client crashed as a result of this bug, please upload the generated crash log. This is found in your launcher's Nomi CEu instance, in a folder called `crash-reports`. If there was no crash, but instead an error screen, please upload your `latest.log`, found in a folder called `logs`. If there was a script error, please upload your `crafttweaker.log`, found in your base instance folder, instead. Otherwise, please leave this field blank."
placeholder: "You can upload into a external site like paste-bin, and send the link, or just drag the file into this text field."
validations:
required: false
- 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.

69
.github/ISSUE_TEMPLATE/002-feature-request.yml vendored Normal file
View File

@ -0,0 +1,69 @@
name: Feature Request
description: Suggest an idea, including mod additions or addon scripts, for Nomi CEu.
labels: enhancement
body:
- type: markdown
attributes:
value: "Note: balancing ideas should use this template, but only for changes. However, if its a problem, not a change, like `X material always runs out`, please use the `Bug Report` Template."
- type: dropdown
id: version
attributes:
label: Nomi CEu Version
description: The version of Nomi CEu you are using as the basis for this feature request. If you do not know what it is, check the title of your instance window. If you do not see your version here, please update to the newest version of the pack, which currently is 1.6, or the newest alpha/beta, which currently is 1.6.1-alpha-1.
options:
- "1.6.1-alpha-1"
- "1.6"
- "1.5.2"
- "1.5.1"
- "1.5"
- "1.4.3"
- "1.4.2"
- "1.4.1a"
- "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: work
attributes:
label: How Will Your Solution Work
description: |
Describe how the solution will fix the problem, or add to the pack.
If you are suggesting a mod, please describe what the mod does, and how it will add to the pack.
placeholder: "Example: If X was done, than Y will get a use, and..."
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: "Alternatives You've Considered"
description: "What alternatives have you considered that might help solve the problem? If you aren't sure, or this is not related to a problem, please leave this field blank."
placeholder: "Example: Otherwise, we can also do Z..."
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional Information
description: "Add any other context or screenshots about the feature request here. If you are suggesting a mod, please also add a link to the mod's CurseForge page."
placeholder: "Example: This main motive for this idea is because X..."
validations:
required: false
- type: markdown
attributes:
value: Thank you for taking the time to fill out this feature request.

42
.github/ISSUE_TEMPLATE/bug_report.md vendored
View File

@ -1,42 +0,0 @@
---
name: Bug report
about: Crashes or unintended behaviors arising from Nomifactory's mods, configurations,
or custom scripts
title: ''
labels: bug
assignees: ''
---
Thanks for taking the time to fill out this report!
Note: if you need general tech support for things like server configuration, or general game support (how to I make this?), Discord is a better venue. Please open an issue only if there is a clear bug with the pack or if you have been asked to by one of the Discord staff.
Check if the bug is fixed on the latest version before submitting. The latest version is v1.6, and the latest beta is v1.6.1-beta-1.
**Pack Version:**
Replace this text with the version number of the pack, or the commit hash, if you downloaded from GitHub.
**Launcher:**
Replace this text with your launcher. If you are using the CurseForge Launcher, please try to see if the issue applies on a different launcher.
**Mode:**
Replace this text with your mode (Normal Mode, Expert Mode or Both Modes).
**Environment:**
Replace this text with your environment. This is whether you are in Singleplayer or Multiplayer, any additional mods you added, and any configurations that were changed from their defaults.
**Description:**
Replace this text with a clear and concise description of what the bug is, so we know what the problem is.
**Expected Behavior:**
Replace this text with a clear and concise description of what the correct behavior would be.
**Steps To Reproduce:**
Replace this text with steps to reproduce the behavior, if applicable. We need to know how to encounter this bug ourselves so we can diagnose it.
**Crash Log:**
If your client crashed as a result of this bug, please upload the generated crash log. This is found in your launcher's Nomifactory CEu profile (aka instance) in a folder called `crash-reports`. If there was no crash, but instead an error screen, please upload your `latest.log` instead.
**Screenshots:**
If applicable, add screenshots to help explain your problem.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Nomi-CEu Discord
url: https://discord.com/invite/zwQzqP8b6q
about: Join us on Discord to discuss questions, gameplay advice, bugs, beta releases, and more.

24
.github/ISSUE_TEMPLATE/feature_request.md vendored
View File

@ -1,24 +0,0 @@
---
name: Feature request
about: Suggest an idea, including mod additions, for Nomifactory.
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe how the solution will work**
Describe how the solution will fix the problem, or add to the pack.
If you are suggesting a mod, please describe what the mod does, and how it will add to the pack.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here. If you are suggesting a mod, please also add a link to the mod's CurseForge page.