Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve issue reporting #3364

Open
wants to merge 16 commits into
base: development
Choose a base branch
from
Open
97 changes: 97 additions & 0 deletions .github/ISSUE_TEMPLATE/1-ui_sprite.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
name: Bug - UI and Sprite (report typos further down)
description: Report an issue with sprites, buttons, backgrounds, visual overlaps etc.
title: "[UI] "
labels: [ 'visual', 'bug' ]
body:
- type: checkboxes
id: existing_issue
attributes:
label: Pre-requisites
options:
- label: I have searched the existing issues
required: true
- label: This issue was encountered (or replicated) on a non-edited Clan
required: true
- type: textarea
id: description
attributes:
label: Description
description: Describe the bug
placeholder: "e.g. My 12 moon mediator apprentice doesn't have their accessory on the mediation screen."
validations:
required: true
- type: dropdown
id: grade
attributes:
label: Grade
description: How much of an impact does this issue have on play?
options:
- Unimportant - Little to no impact on play
- Non-vital - Can easily be ignored and does not have a large impact on play
- Regular - Should be handled soon, but doesn't necessarily break the game or inhibit the player
- Important - Has a large effect on the gameplay but is not urgent
- Dire - Still playable, but a major feature is broken
- Game-breaking - makes it impossible to play the game
default: 2
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: patrol
attributes:
label: Patrol ID + Outcome Print (if applicable)
description: For assistance, see [\"what's a patrol ID and do I need it?\"](https://www.clangen.io/docs/report-a-bug#whats-a-patrol-id-do-i-need-it) and [\"how do I find the patrol ID?\"](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-patrol-id)
- type: input
id: version
attributes:
description: See [here](https://www.clangen.io/docs/report-a-bug/#how-do-i-find-my-game-version) for help finding your game version.
label: "Commit # or Game Version Number"
placeholder: e.g. "4ef20d05" (if on development) or "v0.12.2" (if stable)
validations:
required: true
- type: dropdown
id: fullscreen
attributes:
label: Is this bug only happening in fullscreen?
description: Answer "yes" if the issue is resolved by using windowed mode, or if it relates to fullscreen.
options:
- "No"
- "Yes"
validations:
required: true
- type: input
id: fullscreen_size
attributes:
label: If yes, what is your display size in pixels?
description: Include height and width; this can usually be found in your computer's display settings.
placeholder: e.g. 1920x1080
- type: dropdown
id: fullscreen_config
attributes:
label: Select any visual config options you are using
description: You can select more than one.
multiple: true
options:
- Disable sprite antialiasing
- Ignore fullscreen scaling rules
- Other (specify in additional context)
- type: textarea
id: additional_context
attributes:
label: Additional context
placeholder: Add any other context about the problem here.
- type: textarea
id: screenshots
attributes:
label: Screenshots
placeholder: Add screenshots to help explain your problem.
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/2-audio.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug - Audio
description: Issues related to sound, including playback, sound effects and music
title: "[AUDIO] "
labels: [ 'audio', 'bug']
body:
- type: checkboxes
id: existing_issue
attributes:
label: Pre-requisites
options:
- label: I have searched the existing issues
required: true
- label: This issue was encountered (or replicated) on a non-edited Clan
required: true
- type: textarea
id: description
attributes:
label: Description
description: Describe the bug
placeholder: "e.g. When I enter the medicine cat den, the music stalls for a second before it resumes again."
validations:
required: true
- type: dropdown
id: grade
attributes:
label: Grade
description: How much of an impact does this issue have on play?
options:
- Unimportant - Little to no impact on play
- Non-vital - Can easily be ignored and does not have a large impact on play
- Regular - Should be handled soon, but doesn't necessarily break the game or inhibit the player
- Important - Has a large effect on the gameplay but is not urgent
- Dire - Still playable, but a major feature is broken
- Game-breaking - makes it impossible to play the game
default: 2
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: patrol
attributes:
label: Patrol ID + Outcome Print (if applicable)
description: See [what's a patrol ID and do I need it?](https://www.clangen.io/docs/report-a-bug#whats-a-patrol-id-do-i-need-it) and [how do I find the patrol ID?](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-patrol-id)
- type: input
id: version
attributes:
description: See [here](https://www.clangen.io/docs/report-a-bug/#how-do-i-find-my-game-version) for help finding your game version.
label: "Commit # or Game Version Number"
placeholder: e.g. "4ef20d05" (if on development) or "v0.12.2" (if stable)
validations:
required: true
- type: textarea
id: additional_context
attributes:
label: Additional context
placeholder: Add any other context about the problem here.
- type: textarea
id: screenshots
attributes:
label: Screenshots/Video
placeholder: If applicable, add screenshots or video to help explain your problem.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/3-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Bug - Code
description: General bugs related to how the game runs and responds to you.
title: "[BUG] "
labels: [ 'bug' ]
body:
- type: checkboxes
id: existing_issue
attributes:
label: Pre-requisites
options:
- label: I have searched the existing issues
required: true
- label: This issue was encountered (or replicated) on a non-edited Clan
required: true
- type: textarea
id: description
attributes:
label: Description
description: Describe the bug
placeholder: "e.g. Cats are lost in a moon event but are still in the clan cat list."
validations:
required: true
- type: dropdown
id: grade
attributes:
label: Grade
description: How much of an impact does this issue have on play?
options:
- Unimportant - Little to no impact on play
- Non-vital - Can easily be ignored and does not have a large impact on play
- Regular - Should be handled soon, but doesn't necessarily break the game or inhibit the player
- Important - Has a large effect on the gameplay but is not urgent
- Dire - Still playable, but a major feature is broken
- Game-breaking - makes it impossible to play the game
default: 2
validations:
required: true
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: patrol
attributes:
label: Patrol ID + Outcome Print (if applicable)
description: See [what's a patrol ID and do I need it?](https://www.clangen.io/docs/report-a-bug#whats-a-patrol-id-do-i-need-it) and [how do I find the patrol ID?](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-patrol-id)
- type: input
id: version
attributes:
description: See [here](https://www.clangen.io/docs/report-a-bug/#how-do-i-find-my-game-version) for help finding your game version.
label: "Commit # or Game Version Number"
placeholder: e.g. "4ef20d05" (if on development) or "v0.12.2" (if stable)
validations:
required: true
- type: textarea
id: errormsg
attributes:
label: Error log
description: Attach the full error log here. Details on how to find the error log are given [here](https://www.clangen.io/docs/report-a-bug#how-do-i-find-the-error-log
- type: textarea
id: additional_context
attributes:
label: Additional context
placeholder: Add any other context about the problem here.
- type: textarea
id: screenshots
attributes:
label: Screenshots
placeholder: If applicable, add screenshots to help explain your problem.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/4-enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: Enhancement
description: Suggest changes to the existing code. This is NOT for making suggestions for the game. It's for contributors to request code changes from other contributors, usually ones that have been discussed.
title: "[ENHANCE] "
labels: ['enhancement']
body:
- type: textarea
attributes:
label: Description
description: Please describe the changes you would like to see. Give details on the current behavior vs. the goal behavior. If you have an idea of how specifically this change could be made, explain it.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Project
about: Request assistance with a coding project.
title: "[PROJECT]"
title: "[PROJECT] "
labels: 'help-wanted'
---

Expand Down
73 changes: 0 additions & 73 deletions .github/ISSUE_TEMPLATE/bug_report.yml

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: Bug - Typo (misspellings/improper grammar)
url: https://github.com/ClanGenOfficial/clangen/issues/1818
about: Report an issue with text itself (spelling, punctuation, and grammar).
9 changes: 0 additions & 9 deletions .github/ISSUE_TEMPLATE/enhancement.md

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading