N64FlashcartMenu/.github/ISSUE_TEMPLATE/bug_report.yml
2023-12-17 21:13:41 +00:00

91 lines
3.0 KiB
YAML

name: Bug report
description: Create a bug report to help us improve
labels:
- "Type: Bug"
- "Status: Waiting triage"
body:
- type: markdown
attributes:
value: |
# :warning: **Please read before raising the issue** :warning:
If you have a **question**, need clarification on something, need help on a particular situation or want to start a discussion, **DO NOT** open an issue here. _It will be automatically closed!_
First raise it in discussions.
If you really want to raise an issue, please make sure to follow the template and provide the required information.
Failing to do so will most likely end up on the issue being close. Don't take offense at this.
It is simply a time management decision.
Whenever an issue is raised without following the template and the required information is not provided, very often too much time has to be spent going back and forth to obtain the details that are outlined below.
- type: input
id: firmware_version
attributes:
label: Firmware version of the flashcart
description: The firmware version used
placeholder: V0.1
validations:
required: false
- type: input
id: menu_version
attributes:
label: Menu revision used
description: Press (Start) button on the menu to show the current menu version.
placeholder: e.g 1.2.3.456, N/A
validations:
required: false
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the problem is.
validations:
required: true
- type: textarea
id: repro_steps
attributes:
label: How to reproduce
description: Detailed repro steps so we can see the same problem. If not already explained above.
placeholder: |
1.
2.
...
validations:
required: false
- type: textarea
id: expected_behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen. If applicable.
validations:
required: false
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Very helpful if you send along a few screenshots to help visualize the issue!
placeholder: drag and drop here, if applicable
validations:
required: false
- type: textarea
id: other_things
attributes:
label: Additional information
description: Other suggested things. If applicable/relevant.
placeholder: |
for example link to the repository with sample code
code snippets
validations:
required: false
- type: markdown
attributes:
value: |
### Make an effort to fix the bug
Attempt to submit a [Pull Request (PR)](https://help.github.com/articles/about-pull-requests/) that fixes the bug. Include in this PR a test that verifies the fix. If you were not able to fix the bug, a PR that illustrates your partial progress will suffice.