Skip to content

Commit

Permalink
Issue template updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Exzap committed Jan 19, 2024
1 parent 18679af commit 60f1983
Show file tree
Hide file tree
Showing 2 changed files with 103 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/Emulation_bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Docs - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
name: Bug Report
description: Report an issue with Cemu emulator
title: "Enter a title here"
labels: bug
body:
- type: markdown
id: md_readme
attributes:
value: |
## Important: Read First
If you discovered a bug you can report it here. Please make sure of the following (IMPORTANT!):
- Only report something if you are sure it's a bug and not any technical issue on your end. For troubleshooting help see the [links page](https://github.com/cemu-project/Cemu#links)
- Problems specific to a single game should be reported on the [compatibility wiki](https://wiki.cemu.info/wiki/Main_Page) instead
- Check if the [issue tracker](https://github.com/cemu-project/Cemu/issues) doesn't already have an open issue for the same problem
- type: textarea
id: current_behavior
attributes:
label: Current Behavior
description: "What the bug is, in a brief description"
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: "What did you expect to happen?"
validations:
required: true

- type: textarea
id: steps_to_reproduce
attributes:
label: Steps to Reproduce
description: "How to reproduce the issue"
validations:
required: true
- type: textarea
id: sys_info
attributes:
label: System Info
description: "Place all system Info in the box below"
placeholder: |
Info
OS : Windows 10
CPU : AMD Ryzen 5 7900X Six-Core Processor
GPU : NVIDIA GeForce RTX 4090
Drivers Version : 4.0.0 NVIDIA 512.95
Cemu Version : 2.0
value: |
OS :
CPU :
GPU :
Drivers Version :
Cemu Version :
- type: textarea
id: emulation_settings
attributes:
label: Emulation Settings
description: |
Any non-default core settings.
validations:
required: false
- type: textarea
id: logs_files
attributes:
label: "Logs"
description: |
"Attach `log.txt` from your Cemu folder (*File > Open Cemu folder*)".
validations:
required: false
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Docs - https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
name: Feature suggestion
description: Suggest a new feature
title: "Enter a title for the suggestion here"
labels: feature
body:
- type: markdown
id: md_readme
attributes:
value: |
## Important: Read First
While we appreciate suggestions, it is important to note that we are a very small team and there are already a tenfold more ideas than we could ever implement in the near future. Therefore, please only suggest something if:
- You believe it is a great addition and the idea is reasonably unique
- It is not an
Avoid to create suggestions for:
- Overly obvious features ("Game xyz does not work and should be fixed", "Wiimote support should be improved", "You should add an Android port", "Copy xyz feature from other emulator")
- Niche features that are only interesting to a tiny percentage of users
- Large scale features ("Add a Metal backend for MacOS", "Add ARM support", "Add savestates")
Note that this doesn't mean we aren't interested in these ideas, it's just that ideas are the easy part of the implementation and there is no point to have a suggestions clutter up the issue tracker when they will possibly never be implemented.
Note that these rules are not strict guidelines, but rather a strong recommendation. If you believe your idea is worthwhile even if it doesn't meet all the criteria, you can still try suggesting it.
- type: textarea
id: idea_suggestion
attributes:
label: Current Behavior
description: "What your idea is in as much detail as possible"
validations:
required: true

0 comments on commit 60f1983

Please sign in to comment.