mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-02-02 11:52:44 +01:00
d18b669b8f
<!--- Provide a general summary of your changes in the Title above --> ## Description <!--- Describe your changes in detail --> Improve the bug report template. ## Motivation and Context <!--- What does this sample do? What problem does it solve? --> <!--- If it fixes/closes/resolves an open issue, please link to the issue here --> Recently reported issues lacked the required content for diagnostics. ## How Has This Been Tested? <!-- (if applicable) --> <!--- Please describe in detail how you tested your sample/changes. --> <!--- Include details of your testing environment, and the tests you ran to --> <!--- see how your change affects other areas of the code, etc. --> ## Screenshots <!-- (if appropriate): --> ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Improvement (non-breaking change that adds a new feature) - [ ] Bug fix (fixes an issue) - [ ] Breaking change (breaking change) - [ ] Documentation Improvement - [ ] Config and build (change in the configuration and build system, has no impact on code or features) ## Checklist: <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> <!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> - [ ] My code follows the code style of this project. - [ ] My change requires a change to the documentation. - [ ] I have updated the documentation accordingly. - [ ] I have added tests to cover my changes. - [ ] All new and existing tests passed. <!--- It would be nice if you could sign off your contribution by replacing the name with your GitHub user name and GitHub email contact. --> Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Updated GitHub issue bug report template with new optional input fields - Added fields for N64 console region and configuration file details to help improve issue reporting clarity <!-- end of auto-generated comment: release notes by coderabbit.ai -->
110 lines
3.5 KiB
YAML
110 lines
3.5 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: input
|
|
id: n64_region
|
|
attributes:
|
|
label: N64 console region
|
|
description: PAL, NTSC-U, NTSC-J, MPAL, etc.
|
|
placeholder: NTSC
|
|
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: configuration_file
|
|
attributes:
|
|
label: configuration file(s)
|
|
description: The text of the configuration file(s) used. If applicable.
|
|
placeholder: |
|
|
for example paste the content of the configuration file (config.ini) here.
|
|
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.
|