Skip to content

Commit

Permalink
Merge pull request #634 from Team-EnderIO/chore/update-templates
Browse files Browse the repository at this point in the history
Update GitHub templates
  • Loading branch information
Rover656 authored Mar 19, 2024
2 parents 840bfa7 + 20f590d commit ebbe491
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 81 deletions.
39 changes: 21 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_form.yml
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
name: Bug Report (New)
description: File a bug report.
title: "[BUG] <title>"
name: Bug Report
description: Report a crash or an unexpected behaviour.
title: "Bug Report"
labels: [Type-Bug, Status-Triage]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
description: Please search to see if an issue already exists for the bug you encountered. This helps us to avoid duplicates.
options:
- label: I have searched the existing issues
- label: I did not find any existing issues.
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
description: Explain what is currently happening which you consider to be a bug.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
description: Explain what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
label: How to Test
description: Explain, step-by-step what you did at the time of the problem. Describe factory setups/configurations if necessary.
placeholder: |
1. Go to '...'
2. Click on '....'
Expand All @@ -35,26 +35,29 @@ body:
required: false
- type: textarea
attributes:
label: Environment
label: Local Environment
description: |
examples:
- **OS**: Windows
- **Java version**: Adoptium 16.0.2.7-hotspot
- **Minecraft version**: 1.20.1
- **Operating System**: Windows
- **Java Version**: Adoptium 16.0.2.7-hotspot
- **Minecraft Version**: 1.20.1
- **Version**: 6.0.0
- **Other Mods**: Applied Energistics 2, Mekanism...
value: |
- OS:
- Java version:
- Minecraft version:
- Version:
- **Operating System**:
- **Java version**:
- **Minecraft Version**:
- **Version**:
- **Other Mods**: Applied Energistics 2, Mekanism...
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
label: Any Additional Information?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
If this is a particularly complex issue, consider something like a video clip or gif.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
Expand Down
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_form.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Feature Report
description: Propose a new feature or idea.
title: "Feature Request"
labels: [Type-Feature, Status-Triage]
body:
- type: checkboxes
attributes:
label: Is there an existing proposal for this?
description: Please search to see if an issue already exists for the idea you are proposing. This helps us to avoid duplicates.
options:
- label: I did not find any existing requests.
required: true
- type: textarea
attributes:
label: Explain your idea
description: Explain the proposed feature, include as much detail as necessary to convey it fully.
- type: textarea
attributes:
label: Why do you thing this feature belongs in Ender IO.
description: Explain what purpose this serves as part of this mod. Is it addressing an issue, a gap or something else?
- type: textarea
attributes:
label: Are there any alternatives?
description: Are there any alternative ways of implementing this idea? Especially if this addresses a problem.
validations:
required: false
- type: textarea
attributes:
label: Any Additional Information?
description: |
Links? References? Anything that will give us more context about the proposal.
Tip: You can attach images by clicking this area to highlight it and then dragging files in.
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

17 changes: 8 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
# Description

Please write a summary of the changes you have implemented; explaining your design choices if necessary. Please also include a list of things to test if it isn't clear.
Please also disclose whether this is a breaking change.

Closes #(issue) <!-- Follow this exact pattern for every issue you've fixed to help GitHub automatically link your PR to the relevant issues -->
<!-- If you're submitting a Draft PR, consider providing a TODO list using checkboxes -->
# TODO

<!-- Remove this section if you're submitting an already-complete PR -->
# Todo
- [ ] If this is a draft, populate this with remaining tasks. Otherwise, remove this section.

- [ ] Things that are yet to be completed for this PR to no longer be a draft.
# Breaking Changes

<!-- For drafts, fill this in as you go; if you are leaving draft, make sure these are all done -->
# Checklist:
List any breaking changes in this section, such as: changed/removed APIs, changed or removed items/blocks or modifications to recipes and gameplay mechanics.

<!-- For drafts, fill this in as you go; if you are leaving draft, make sure these are all complete. -->
# Checklist

- [ ] My code follows the style guidelines of this project (.editorconfig, most IDEs will use this for you).
- [ ] I have performed a self-review of my own code.
- [ ] I have commented my code in areas it may be challenging to understand. <!-- (Although we prefer code that is readable instead of over-commented) -->
- [ ] I have made corresponding changes to the documentation.
- [ ] My changes are ready for review from a contributor.

Expand Down

0 comments on commit ebbe491

Please sign in to comment.