[SC64] Updated GitHub issue/PR templates

This commit is contained in:
Mateusz Faderewski 2024-10-11 18:26:46 +02:00
parent cc41652e6f
commit 93ab101be4
6 changed files with 56 additions and 72 deletions

1
.github/FUNDING.yml vendored
View File

@ -1,2 +1 @@
github: polprzewodnikowy
ko_fi: polprzewodnikowy ko_fi: polprzewodnikowy

View File

@ -1,27 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1.
2.
3.
4.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Expected behavior**
A clear and concise description of what you expected to happen.
**Possible solution**
Not obligatory, but suggest a fix/reason for the bug.

55
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,55 @@
name: Bug Report
description: File a bug report.
title: "[SC64][BUG] "
labels: ["bug"]
assignees:
- Polprzewodnikowy
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: sanity-check
attributes:
label: Is your issue really a bug?
description: |
Issue tracker in this repository is for **BUG REPORTS ONLY**.
Make sure your problem is caused by the firmware and **not** by the software you're running on the flashcart.
Errors in the documentation are also considered a bug.
If your issue is related to the menu then report it in the [N64FlashcartMenu] repository.
[N64FlashcartMenu]: https://github.com/Polprzewodnikowy/N64FlashcartMenu
options:
- label: My issue is indeed a bug in the flashcart firmware and/or documentation and I can prove it.
required: true
- label: I understand the difference in responsibilities between flashcart firmware and menu software.
required: true
- type: input
id: version
attributes:
label: Firmware version
placeholder: v2.20.0
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: Describe the bug
description: |
Tell us what you noticed as a bug, and what is your expected outcome.
The more detailed the description is the better.
If applicable please attach screenshots and/or video showing the problem.
validations:
required: true
- type: textarea
id: deployer-info
attributes:
label: Output logs from `sc64deployer info`
description: Please copy and paste the output from the command specified above.
render: shell
validations:
required: true

View File

@ -1,8 +1,5 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: GitHub Discussions
url: https://github.com/Polprzewodnikowy/SummerCart64/discussions
about: Please use for QUESTIONS, conversations or discussions.
- name: N64brew Discord - name: N64brew Discord
url: https://discord.gg/8VNMKhxqQn url: https://discord.gg/8VNMKhxqQn
about: Alternative channel for asking QUESTIONS. about: The go-to community to ask about SummerCart64

View File

@ -1,20 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

View File

@ -1,20 +0,0 @@
**Description**
Provide a headline summary of your changes in the Title above.
Describe your changes in detail.
**Related Issue**
This project only accepts pull requests related to open issues.
If suggesting a change, please discuss it in an issue first.
If fixing a bug, there should be an issue describing it with steps to reproduce.
Please link to the issue here:
**Motivation and Context**
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
**How Has This Been Tested?**
Please describe in detail how you tested your 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 applicable, add screenshots to help demonstrate your feature/bugfix.