Skip to content

Commit

Permalink
Merge Better Issue Templates #1016
Browse files Browse the repository at this point in the history
  • Loading branch information
poco0317 committed Sep 18, 2021
2 parents a046846 + 5a6e5a4 commit 4b6f47b
Show file tree
Hide file tree
Showing 6 changed files with 170 additions and 50 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: 🐞 Bug Report
description: File a report to help us improve Etterna!
title: "[Bug]: "
labels: ["Type: Bug", "Needs triage"]

body:
- type: markdown
attributes:
value: |
## Thanks for taking the time to fill out this bug report! Please make sure to check if the bug has already been reported before submitting a new report.
- 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.
options:
- label: I have searched the existing issues
required: true

- type: input
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: [email protected], Discord#1234, Just reply to the issue...
validations:
required: false

- type: dropdown
attributes:
label: Version Info
description: What version of Etterna are you running?
options:
- Latest available release
- Compiled from develop
validations:
required: true

- type: dropdown
attributes:
label: What operating system are you seeing the problem on?
multiple: true
options:
- Windows
- macOS
- Linux (any distro)

- type: textarea
attributes:
label: Bug Behavior
description: Describe the bug you're currently experiencing.
validations:
required: false

- type: textarea
attributes:
label: Expected Behavior
description: What should have happened instead?
validations:
required: false

- type: textarea
attributes:
label: Reproduction Steps
description: What steps should we follow to see the bug?
placeholder: |
1. Run the game
2. Select "Game Start"
3. Open the debug menu
4. '...'
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 🛠️ Feature Request
description: Share your ideas on how to improve the game!
title: "[Feature Request]: "
labels: ["Type: Enhancement"]

body:
- type: checkboxes
attributes:
label: Is there an existing issue for the feature?
description: Please search to see if an issue already suggested the feature you're thinking.
options:
- label: I have searched the existing feature requests
required: true

- type: textarea
attributes:
label: Describe the Feature
description: What is the addition you are proposing?
validations:
required: true

- type: textarea
attributes:
label: How Does The Feature Add To The Game?
description: (Explain the problem the feature aims to solve, or the new things it allows)
placeholder: |
In Etterna, it was previously not possible to ...
However, this feature lets players ...
validations:
required: true

- type: textarea
attributes:
label: Additional Context
description: |
If you have any background information that would help implement the feature, put it here.
(e.g. knowing which section of the code would have to be changed, or describing how another game implemented a similar thing)
validations:
required: false
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/03-build_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: ⚙️ Build Issue
description: Having a problem building Etterna? Let us know here!
labels: ["Type: Maintenance"]
title: "[Build Issue]: "
assignees:
- jameskr97

body:
- type: checkboxes
attributes:
label: Have you read through the build instructions before reading this?
description: All information related to building Etterna is written in that document
options:
- label: I have read the build instructions
required: true

- type: dropdown
attributes:
label: What operating system are you seeing the problem on?
multiple: true
options:
- Windows
- macOS
- Linux (any distro)

- type: textarea
attributes:
label: Describe the build issue
description: What problem do you have when building Etterna?
validations:
required: true

- type: textarea
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell

- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
29 changes: 0 additions & 29 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 💬 Contact us on the Etterna Dev Group Discord
url: https://discord.gg/ZqpUjsJ
about: Join the EDG Discord for support and discussion with the devs.
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 4b6f47b

Please sign in to comment.