docs(github): Improvements to Github Issues templates

This commit is contained in:
Hundrec 2024-09-25 15:25:45 -07:00 committed by Cameron Taylor
parent c5a76cf1d5
commit 67f7b638fb
3 changed files with 56 additions and 39 deletions

View file

@ -6,38 +6,42 @@ body:
- type: checkboxes
attributes:
label: Issue Checklist
description: Be sure to complete these steps to increase the chances of your issue being addressed!
options:
- label: I have properly named the issue
- label: I have checked the issues/discussions pages to see if the issue has been previously reported
- label: I have properly named my issue
- label: I have checked the Issues/Discussions pages to see if my issue has already been reported
- type: dropdown
attributes:
label: What platform are you using?
label: Platform
description: Which platform are you playing on?
options:
- Newgrounds (Web)
- Itch.io (Web)
- Newgrounds (Web/HTML5)
- Itch.io (Web/HTML5)
- Itch.io (Downloadable Build) - Windows
- Itch.io (Downloadable Build) - MacOS
- Itch.io (Downloadable Build) - Linux
- Compiled from GitHub Source Code
validations:
required: true
- type: dropdown
attributes:
label: If you are playing on a browser, which one are you using?
label: Browser
description: (Web/HTML5 users only) Which browser are you playing on?
options:
- Google Chrome
- Microsoft Edge
- Firefox
- Opera
- Safari
- Other (Specify below)
- Other (Specify in Description field)
- type: input
attributes:
label: Version
description: What version are you using?
placeholder: ex. 0.4.1
description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
placeholder: ex. 0.5.0
validations:
required: true
@ -49,14 +53,16 @@ body:
attributes:
value: "### Please do not report issues from other engines. These must be reported in their respective repositories."
- type: markdown
- type: textarea
attributes:
value: "#### Provide as many details as you can."
label: Description (include any images, videos, errors, or crash logs)
description: Provide as much detail as you can. The better others understand your issue, the more they can help you!
placeholder: Describe your issue here...
validations:
required: true
- type: textarea
attributes:
label: Context (Provide images, videos, etc.)
- type: textarea
attributes:
label: Steps to reproduce (or crash logs, errors, etc.)
label: Steps to Reproduce
description: What steps can other people take to reliably encounter this issue?
placeholder: 1. Open the game...

View file

@ -6,65 +6,73 @@ body:
- type: checkboxes
attributes:
label: Issue Checklist
description: Be sure to complete these steps to increase the chances of your issue being addressed!
options:
- label: I have properly named the issue
- label: I have checked the issues/discussions pages to see if the issue has been previously reported
- label: I have properly named my issue
- label: I have checked the Issues/Discussions pages to see if my issue has already been reported
- type: dropdown
attributes:
label: What platform are you using?
label: Platform
description: Which platform are you playing on?
options:
- Newgrounds (Web)
- Itch.io (Web)
- Newgrounds (Web/HTML5)
- Itch.io (Web/HTML5)
- Itch.io (Downloadable Build) - Windows
- Itch.io (Downloadable Build) - MacOS
- Itch.io (Downloadable Build) - Linux
- Compiled from GitHub Source Code
validations:
required: true
- type: dropdown
attributes:
label: If you are playing on a browser, which one are you using?
label: Browser
description: (Web/HTML5 users only) Which browser are you playing on?
options:
- Google Chrome
- Microsoft Edge
- Firefox
- Opera
- Safari
- Other (Specify below)
- Other (Specify in Description field)
- type: input
attributes:
label: Version
description: What version are you using?
placeholder: ex. 0.4.1
description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
placeholder: ex. 0.5.0
validations:
required: true
- type: markdown
attributes:
value: "## Describe your issue."
value: "## Describe the crash."
- type: markdown
attributes:
value: "### Please do not report issues from other engines. These must be reported in their respective repositories."
- type: markdown
attributes:
value: "#### Provide as many details as you can."
- type: textarea
attributes:
label: Context (Provide screenshots or videos of the crash happening)
- type: textarea
attributes:
label: Steps to reproduce
label: Description
description: Include screenshots or videos of the crash happening. Provide as much detail as you can.
placeholder: Describe the crash here...
validations:
required: true
- type: textarea
attributes:
label: Crash logs (can be found in the logs folder where Funkin.exe is)
label: Steps to Reproduce
description: What steps can other people take to reliably trigger this crash?
placeholder: 1. Open the game...
validations:
required: true
- type: textarea
attributes:
label: Crash logs
description: These can be found in the logs folder where Funkin.exe is.
placeholder: Upload your logs here...
validations:
required: true

View file

@ -6,10 +6,13 @@ body:
- type: checkboxes
attributes:
label: Issue Checklist
description: Be sure to complete these steps to increase the chances of your suggestion being considered!
options:
- label: I have properly named the enhancement
- label: I have checked the issues/discussions pages to see if the enhancement has been previously suggested
- label: I have properly named my enhancement
- label: I have checked the Issues/Discussions pages to see if my enhancement has already been suggested
- type: textarea
attributes:
label: What is your suggestion, and why should it be implemented?
validations:
required: true