GitHub: Switch to issue form templates.

This commit is contained in:
Unknown W. Brackets 2021-07-31 22:28:09 -07:00
parent 8d7f57c472
commit eee2093433
10 changed files with 585 additions and 180 deletions

View File

@ -1,34 +0,0 @@
---
name: Bug, crash, or compatibility issue
about: Choose this if something doesn't work and no other template applies.
labels: needs triage
---
<!-- Want the issue fixed faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
You can remove this stuff - just don't forget to answer the questions.
They're important. -->
### What happens?
### What *should* happen?
### What are you using?
#### What hardware / device and operating system?
#### What graphics card (GPU) or mobile phone model?
#### What PPSSPP version (standalone/official), and did it work before?
#### Which game or games?
<!-- Long press on the game in PPSSPP to include the game ID. -->
#### Checklist
<!-- Don't forget the below, change [ ] to [X] when done. Note anything else you tried. -->
- [ ] Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed.
- [ ] [Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue.
- [ ] Try resetting settings or older versions and include if the issue is related.
- [ ] Include logs or screenshots of issue.

135
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@ -0,0 +1,135 @@
name: Bug, crash, or compatibility issue
description: Choose this if something doesn't work and no other template applies.
body:
- type: markdown
attributes:
value: |
Want the issue fixed faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
- type: input
id: game
validations:
required: true
attributes:
label: Game or games this happens in
placeholder: ULUS-10336 - Crisis Core
description: >
Shown in the title bar, logs, and long press on the game icon. If it's outside a game, put 'None.'
- type: textarea
id: reproduction
validations:
required: true
attributes:
label: What area of the game / PPSSPP
placeholder: |
When I equip a Mythril Bangle, a blue screen appears and it says the game crashed.
Here's a screenshot of the blue screen:
[upload screenshot]
Here's a my savedata with a Mythril Bangle not equipped yet:
[upload zip of savedata]
description: >
Try to explain so someone else could do the same thing. Upload savedata if possible to make it easier to reproduce.
- type: textarea
id: desired
validations:
required: true
attributes:
label: What should happen
placeholder: |
The Mythril Bangle should be equipped without crashing.
My friend also tried this on their actual PSP, and it worked fine. Here's a screenshot right after equipping frmo my savedata:
[upload photo]
description: >
If it's a crash, just say "It shouldn't crash." For more complex bugs, it helps to explain what should happen as it's not always obvious.
- type: textarea
id: logs
attributes:
label: Logs
placeholder: '[drag files here...]'
description: |
Upload logs if possible (use DebugLog.bat on Windows or [adb logcat][] on Android.)
[adb logcat]: https://github.com/hrydgard/ppsspp/wiki/How-to-get-an-adb-logcat-from-a-PC
- type: markdown
attributes:
value: |
## Your device
If you're not sure about any of these questions, check Settings -> Tools -> System Information.
- type: dropdown
id: platform
validations:
required: true
attributes:
label: Platform
options:
- Android
- Windows
- libretro / Retroarch
- iOS
- Switch
- Raspberry Pi
- Linux / BSD
- macOS
- Other
- type: input
id: device
validations:
required: true
attributes:
label: Mobile phone model or graphics card
placeholder: Google Pixel 4a or NVIDIA GeForce GTX 1080Ti
description: >
If you don't know, copy what's under 'Driver version' in System Information.
- type: input
id: version
validations:
required: true
attributes:
label: PPSSPP version affected
placeholder: v2.0.0-999-gabcdef123
description: >
Shown on the main screen of PPSSPP where games are listed.
- type: input
id: workingversion
attributes:
label: Last working version
placeholder: v2.0.0-500-g321fedcba
description: >
If it worked before, it's usually easier to narrow down a fix.
- type: dropdown
id: gpubackend
validations:
required: true
attributes:
label: Graphics backend (3D API)
options:
- Vulkan
- OpenGL / GLES
- Direct3D 11
- Direct3D 9
- Other
- type: checkboxes
attributes:
label: Checklist
options:
- label: "Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed."
required: true
- label: "[Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue."
required: true
- label: "Try resetting settings or older versions and include if the issue is related."
- label: "Try without any cheats and without loading any save states."
- label: "Include logs or screenshots of issue."

View File

@ -1,31 +0,0 @@
---
name: Building or contributing
about: Choose for issues building PPSSPP on certain platforms or with certain toolsets.
labels: needs triage
---
<!-- You can remove this stuff - just don't forget to answer the questions.
They're important. -->
### What platform, compiler, and build tools?
### What compile flags or command did you run specifically?
### What happens (don't forget logs)?
### What are you using?
#### What hardware / device and operating system?
#### What PPSSPP version (standalone/official), and did it work before?
#### Checklist
<!-- Don't forget the below, change [ ] to [X] when done. Note anything else you tried. -->
- [ ] Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed.
- [ ] Don't forget `git submodule update --init --recursive`.
- [ ] [Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue.
- [ ] Try deleting the build directory and starting fresh.
- [ ] Include logs and help us reproduce.
- [ ] Check GitHub Actions, which builds every merge and PR.

95
.github/ISSUE_TEMPLATE/build.yml vendored Normal file
View File

@ -0,0 +1,95 @@
name: Building or contributing
description: Choose for issues building PPSSPP on certain platforms or with certain toolsets.
body:
- type: dropdown
id: platform
attributes:
label: Platform
options:
- Android
- Windows
- libretro / Retroarch
- iOS
- Switch
- Raspberry Pi
- Linux / BSD
- macOS
- Other
- type: input
id: buildversions
validations:
required: true
attributes:
label: Compiler and build tool versions
placeholder: Clang 8.0.0 + CMake 3.21.1
description: >
The more detail, the better.
- type: input
id: osversion
validations:
required: true
attributes:
label: Operating system version
placeholder: Arch Linux 2021.08.01
- type: textarea
id: commands
validations:
required: true
attributes:
label: Build commands used
placeholder: './b.sh --release'
description: >
Include the command or commands you ran, script you used, build arguments, etc.
- type: textarea
id: problem
validations:
required: true
attributes:
label: What happens
placeholder: |
I receive the following error:
```
ld.gold: undefined reference to function 'vkCreateWaylandSurfaceKHR'
```
Here's the entire build log:
[upload zip file of log]
description: >
Include logs and as much detail as possible. Paste exact error messages.
- type: input
id: version
validations:
required: true
attributes:
label: PPSSPP version affected
placeholder: v2.0.0-999-gabcdef123
description: >
Use `git describe` if a git checkout. Please try the latest git build if using an older version.
- type: input
id: workingversion
attributes:
label: Last working version
placeholder: v2.0.0-500-g321fedcba
description: >
If it worked before, it's usually easier to narrow down a fix.
- type: checkboxes
attributes:
label: Checklist
options:
- label: "Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed."
required: true
- label: "Make sure to run `git submodule update --init --recursive` before building."
required: true
- label: "[Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue."
required: true
- label: "Try deleting the build directory and running the build again."
required: true
- label: "Check GitHub Actions, which builds every merge and PR."
- label: "Include logs and help us reproduce."

View File

@ -1,30 +0,0 @@
---
name: New feature or behavior change
about: Choose when something isn't broken, but you want it to be better.
labels: needs triage
---
<!-- Want the improvement faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
You can remove this stuff - just don't forget to answer the questions.
They're important. -->
### What should happen?
### Who would benefit from it?
### What's it specific to (remove if not)?
#### Hardware, device, or operating system?
#### Specific games?
<!-- Requests for mods to game logic belong in the forum or Discord. -->
### Does anything else have a similar feature?
#### Checklist
<!-- Don't forget the below, change [ ] to [X] when done. Note anything else you tried. -->
- [ ] Check the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already implemented.
- [ ] [Search for other requests](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same feature.

73
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@ -0,0 +1,73 @@
name: New feature or behavior change
description: "Choose when something isn't broken, but you want it to be better."
body:
- type: markdown
attributes:
value: |
Want the improvement faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
- type: textarea
id: desired
validations:
required: true
attributes:
label: What should happen
placeholder: |
PPSSPP should have a button that makes all graphics look like the screen was cracked.
The button should always be present on the screen and be labeled "Drop PSP".
description: >
Be specific and descriptive.
- type: textarea
id: audience
validations:
required: true
attributes:
label: Who would this benefit
placeholder: |
No one really. I know it'd be a lot of work but it'd be fun for a 2 minute nostalgia trip since I've dropped by PSP before.
description: >
PPSSPP features are contributed by the community, so explaining who else would benefit may help your case.
- type: dropdown
id: platform
attributes:
label: Platform (if relevant)
options:
- Android
- Windows
- libretro / Retroarch
- iOS
- Switch
- Raspberry Pi
- Linux / BSD
- macOS
- Other
- type: input
id: game
validations:
required: true
attributes:
label: Games this would be useful in
placeholder: 'ULUS-10336 - Crisis Core, ULUS-10482 - Lunar: Silver Star Harmony'
description: >
Requests for mods to game logic belong in the forum or Discord. This isn't the place to request game hacks.
- type: textarea
id: notes
attributes:
label: Other emulators or software with a similar feature
description: >
May be helpful in showing someone how it'd be helpful.
- type: checkboxes
attributes:
label: Checklist
options:
- label: "Check the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already implemented."
required: true
- label: "[Search for other requests](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same feature."
required: true

View File

@ -1,43 +0,0 @@
---
name: Graphics or rendering issue
about: Choose when something is drawing wrong.
labels: needs triage
---
<!-- Want the issue fixed faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
You can remove this stuff - just don't forget to answer the questions.
They're important. -->
### What happens?
<!-- Include screenshots and explain why they're wrong. -->
### What *should* happen?
### Include a GE frame capture
<!-- See: https://github.com/hrydgard/ppsspp/wiki/How-to-create-a-frame-dump
Make sure the issue is visible when you take it. -->
### What are you using?
#### What hardware / device and operating system?
#### What graphics card (GPU) or mobile phone model?
#### What PPSSPP version (standalone/official), and did it work before?
#### Which game or games?
<!-- Long press on the game in PPSSPP to include the game ID. -->
#### Graphics backend (Vulkan, OpenGL, etc.)?
#### Checklist
<!-- Don't forget the below, change [ ] to [X] when done. Note anything else you tried. -->
- [ ] Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed.
- [ ] [Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue.
- [ ] Try resetting settings or older versions and include if the issue is related.
- [ ] Try changing graphics settings to determine if one causes the bug.
- [ ] Include logs or screenshots of issue.

149
.github/ISSUE_TEMPLATE/graphics.yml vendored Normal file
View File

@ -0,0 +1,149 @@
name: Graphics or rendering issue
description: Choose when something is drawing wrong.
body:
- type: markdown
attributes:
value: |
Want the issue fixed faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
- type: input
id: game
validations:
required: true
attributes:
label: Game or games this happens in
placeholder: ULUS-10336 - Crisis Core
description: >
Shown in the title bar, logs, and long press on the game icon.
- type: textarea
id: reproduction
validations:
required: true
attributes:
label: What area of the game
placeholder: 'At the start of Chapter 3, in Sector 8. Right outside the briefing room, the save point looks garbled.'
description: >
If it happens from the start of any game, just say "After new game". Try to explain so someone else could do the same thing.
- type: textarea
id: problem
validations:
required: true
attributes:
label: What happens
placeholder: |
The save point seems to be moving like it should, but the colors all all wrong - it shouldn't be red. Here's what it looks like:
[upload screenshot]
Even when I step into it, it turned black which it shouldn't:
[upload screenshot]
description: >
Include screenshots, they're important. But explain what's wrong in the screenshot - it may not be obvious to others.
- type: textarea
id: desired
validations:
required: true
attributes:
label: What should happen
placeholder: |
The save point should look like it does in other places:
[upload screenshot]
My friend also tried this on their actual PSP, where it looks right:
[upload photo]
description: >
If you can include a screenshot (from a previous version, another emulator, or a PSP), it helps a lot. But explaining how it should look helps a lot too.
- type: markdown
attributes:
value: |
Including a frame capture (or multiple) usually helps a lot. These are like 3D screenshots for PPSSPP. Instructions are available [on the wiki][] to create one.
[on the wiki]: https://github.com/hrydgard/ppsspp/wiki/How-to-create-a-frame-dump
- type: textarea
id: screenshots
attributes:
label: GE frame capture
placeholder: '[drag files here...]'
description: >
You can upload the frame capture or captures as a zip file. Make sure the issue is visible on screen during the capture.
- type: markdown
attributes:
value: |
## Your device
If you're not sure about any of these questions, check Settings -> Tools -> System Information.
- type: dropdown
id: platform
validations:
required: true
attributes:
label: Platform
options:
- Android
- Windows
- libretro / Retroarch
- iOS
- Switch
- Raspberry Pi
- Linux / BSD
- macOS
- Other
- type: input
id: device
validations:
required: true
attributes:
label: Mobile phone model or graphics card
placeholder: Google Pixel 4a or NVIDIA GeForce GTX 1080Ti
description: >
If you don't know, copy what's under 'Driver version' in System Information.
- type: input
id: version
validations:
required: true
attributes:
label: PPSSPP version affected
placeholder: v2.0.0-999-gabcdef123
description: >
Shown on the main screen of PPSSPP where games are listed.
- type: input
id: workingversion
attributes:
label: Last working version
placeholder: v2.0.0-500-g321fedcba
description: >
If it worked before, it's usually easier to narrow down a fix.
- type: dropdown
id: gpubackend
validations:
required: true
attributes:
label: Graphics backend (3D API)
options:
- Vulkan
- OpenGL / GLES
- Direct3D 11
- Direct3D 9
- Other
- type: checkboxes
attributes:
label: Checklist
options:
- label: "Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed."
required: true
- label: "[Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue."
required: true
- label: "Try resetting settings or older versions and include if the issue is related."
- label: "Try changing graphics settings to determine if one causes the glitch (especially speed hacks or enhancements/replacements.)"
- label: "Include logs or screenshots of issue."

View File

@ -1,42 +0,0 @@
---
name: Slowdown or performance problem
about: Choose when things got slower from a previous version or a specific scene runs really poorly.
labels: needs triage
---
<!-- Want the issue fixed faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
You can remove this stuff - just don't forget to answer the questions.
They're important. -->
### What games and where in them does it happen?
<!-- Long press on the game in PPSSPP to include the game ID. -->
### What speed are you getting with PPSSPP speed display enabled?
### Include a GE frame capture and debug stats
<!-- See: https://github.com/hrydgard/ppsspp/wiki/How-to-create-a-frame-dump
Many performance issues are graphics related.
Also enable "Show debug statistics" and include a screenshot while it's on. -->
### What are you using?
#### What hardware / device and operating system?
#### What graphics card (GPU) or mobile phone model?
#### What PPSSPP version (standalone/official), and did it work before?
#### Graphics backend (Vulkan, OpenGL, etc.)?
#### Checklist
<!-- Don't forget the below, change [ ] to [X] when done. Note anything else you tried. -->
- [ ] Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed.
- [ ] [Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue.
- [ ] Try resetting settings or older versions and include if the issue is related.
- [ ] Try changing graphics settings to determine if one causes the slowdown.
- [ ] Include logs of screenshots of issue.

133
.github/ISSUE_TEMPLATE/performance.yml vendored Normal file
View File

@ -0,0 +1,133 @@
name: Slowdown or performance problem
description: Choose when things got slower from a previous version or a specific scene runs really poorly.
body:
- type: markdown
attributes:
value: |
Want the issue fixed faster? Check the wiki for tips:
https://github.com/hrydgard/ppsspp/wiki/How-to-report-an-issue-properly
- type: input
id: game
validations:
required: true
attributes:
label: Game or games this happens in
placeholder: ULUS-10336 - Crisis Core
description: >
Shown in the title bar, logs, and long press on the game icon.
- type: textarea
id: reproduction
validations:
required: true
attributes:
label: What area of the game
placeholder: 'At the start of Chapter 3, in Sector 8. It got slow when I talked to the Sephiroth fan.'
description: >
If it happens from the start of any game, just say "After new game". Try to explain so someone else could do the same thing.
- type: input
id: speed
attributes:
label: Speed seen in PPSSPP
placeholder: 75% (45/60)
description: Enable FPS and Speed display in settings.
- type: markdown
attributes:
value: |
Many performance issues are graphics related. Instructions are available [on the wiki][] to create a frame capture.
Please also include 1 or 2 screenshots during the performance problem while "Show debug statistics" (in Settings) is enabled.
[on the wiki]: https://github.com/hrydgard/ppsspp/wiki/How-to-create-a-frame-dump
- type: textarea
id: screenshots
attributes:
label: GE frame capture and debug statistics
placeholder: '[drag files here...]'
description: >
You can upload the frame capture as a zip file, and upload screenshots directly.
- type: markdown
attributes:
value: |
## Your device
If you're not sure about any of these questions, check Settings -> Tools -> System Information.
- type: dropdown
id: platform
validations:
required: true
attributes:
label: Platform
options:
- Android
- Windows
- libretro / Retroarch
- iOS
- Switch
- Raspberry Pi
- Linux / BSD
- macOS
- Other
- type: input
id: device
validations:
required: true
attributes:
label: Mobile phone model or graphics card
placeholder: Google Pixel 4a or NVIDIA GeForce GTX 1080Ti
description: >
If you don't know, copy what's under 'Driver version' in System Information.
- type: input
id: version
validations:
required: true
attributes:
label: PPSSPP version affected
placeholder: v2.0.0-999-gabcdef123
description: >
Shown on the main screen of PPSSPP where games are listed.
- type: input
id: workingversion
attributes:
label: Last working version
placeholder: v2.0.0-500-g321fedcba
description: >
If it worked before, it's usually easier to narrow down a fix.
- type: dropdown
id: gpubackend
validations:
required: true
attributes:
label: Graphics backend (3D API)
options:
- Vulkan
- OpenGL / GLES
- Direct3D 11
- Direct3D 9
- Other
- type: textarea
id: notes
attributes:
label: Any other notes or things you've tried
- type: checkboxes
attributes:
label: Checklist
options:
- label: "Test in the [latest git build](https://buildbot.orphis.net/ppsspp/) in case it's already fixed."
required: true
- label: "[Search for other reports](https://github.com/hrydgard/ppsspp/search?q=my+issue&type=issues) of the same issue."
required: true
- label: "Try resetting settings or older versions and include if the issue is related."
- label: "Try changing graphics settings to determine if one causes the slowdown."
- label: "Include logs or screenshots of issue."