mirror of
https://github.com/ninjamuffin99/Funkin.git
synced 2025-11-26 06:09:02 +00:00
Merge pull request #2717 from tposejank/better-templates
[FEATURE] Better issue and pull request templates
This commit is contained in:
commit
712792c385
51
.github/ISSUE_TEMPLATE/bug.md
vendored
51
.github/ISSUE_TEMPLATE/bug.md
vendored
|
|
@ -1,51 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug Report
|
|
||||||
about: Report a bug or critical performance issue
|
|
||||||
title: 'Bug Report: [DESCRIBE YOUR BUG IN DETAIL HERE]'
|
|
||||||
labels: 'status: pending triage'
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- FILL THIS ISSUE THING OUT AS MUCH AS POSSIBLE
|
|
||||||
OR ELSE YOUR ISSUE WILL BE LESS LIKELY TO BE SOLVED!
|
|
||||||
|
|
||||||
Do not post about issues from other FNF mod engines!
|
|
||||||
We cannot and probably won't solve those!
|
|
||||||
You can hopefully go to their respective GitHub issues pages and report them there, thank you :)
|
|
||||||
|
|
||||||
Please check for duplicates or similar issues, as well as performing simple troubleshooting steps (such as clearing cookies, clearing AppData, trying another browser) before submitting an issue.
|
|
||||||
|
|
||||||
From Joel On Software:
|
|
||||||
|
|
||||||
"It’s pretty easy to remember the rule for a good bug report. Every good bug report needs exactly three things.
|
|
||||||
|
|
||||||
1. Steps to reproduce,
|
|
||||||
2. What you expected to see, and
|
|
||||||
3. What you saw instead."
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
## Describe the Bug
|
|
||||||
<!-- A clear and concise description of what the bug is. -->
|
|
||||||
|
|
||||||
## To Reproduce
|
|
||||||
<!-- Describe IN DETAIL how to reproduce the bug/issue you are running into. -->
|
|
||||||
|
|
||||||
## Expected Behavior
|
|
||||||
<!-- A clear and concise description of what you expected to happen. -->
|
|
||||||
|
|
||||||
## Screenshots/Video
|
|
||||||
<!-- If applicable, add screenshots/video to help explain your problem.
|
|
||||||
Remember to mark the area in the application that's impacted. -->
|
|
||||||
|
|
||||||
## Desktop
|
|
||||||
- OS:
|
|
||||||
<!-- [e.g. Windows 10, 11, Mac, Linux Mint, Ubuntu, Arch (btw)] -->
|
|
||||||
- Browser:
|
|
||||||
<!-- [e.g. Chrome, Safari, Firefox, Edge, OperaGX, or None if you're playing the downloaded version!] -->
|
|
||||||
- Version:
|
|
||||||
<!-- [e.g. 0.4.0, 0.3.3, this can be found in the bottom left corner of the main menu!] -->
|
|
||||||
|
|
||||||
## Additional Context
|
|
||||||
<!-- Add any other context about the problem here. -->
|
|
||||||
|
|
||||||
<!-- If your game is FROZEN and you're playing a web version, press F12 to open up the browser dev window, go to the "Console" tab, and copy-paste whatever red error you're getting below -->
|
|
||||||
61
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
61
.github/ISSUE_TEMPLATE/bug.yml
vendored
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
name: Bug Report
|
||||||
|
description: Report a bug or an issue in the game
|
||||||
|
labels: ["type: minor bug", "status: pending triage"]
|
||||||
|
title: "Bug Report: "
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Issue Checklist
|
||||||
|
options:
|
||||||
|
- label: I have properly named the issue
|
||||||
|
- label: I looked in issues/discussions, if it has been previously reported
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: What platform are you using?
|
||||||
|
options:
|
||||||
|
- Itch.io - Windows
|
||||||
|
- Itch.io - MacOS
|
||||||
|
- Itch.io - Linux
|
||||||
|
- Newgrounds (Web)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: If you were playing on a browser, which one were you using?
|
||||||
|
options:
|
||||||
|
- Google Chrome
|
||||||
|
- Microsoft Edge
|
||||||
|
- Firefox
|
||||||
|
- Opera
|
||||||
|
- Safari
|
||||||
|
- Other (Specify below)
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Version
|
||||||
|
description: What version were you using?
|
||||||
|
placeholder: ex. 0.4.1
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Describe your bug."
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "### Please do not report issues from other engines. These must be reported in their repositories."
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "#### Provide as many details as you can."
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Context (Provide images, videos, etc.)
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce (or crash logs, errors, etc.)
|
||||||
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
1
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
blank_issues_enabled: false
|
||||||
69
.github/ISSUE_TEMPLATE/crash.yml
vendored
Normal file
69
.github/ISSUE_TEMPLATE/crash.yml
vendored
Normal file
|
|
@ -0,0 +1,69 @@
|
||||||
|
name: Crash Report
|
||||||
|
description: Report a crash that occurred while playing.
|
||||||
|
labels: ["type: major bug", "status: pending triage"]
|
||||||
|
title: "Crash: "
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Issue Checklist
|
||||||
|
options:
|
||||||
|
- label: I have properly named the issue
|
||||||
|
- label: I looked in issues/discussions, if it has been previously reported
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: What platform are you using?
|
||||||
|
options:
|
||||||
|
- Itch.io - Windows
|
||||||
|
- Itch.io - MacOS
|
||||||
|
- Itch.io - Linux
|
||||||
|
- Newgrounds (Web)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: If you were playing on a browser, which one were you using?
|
||||||
|
options:
|
||||||
|
- Google Chrome
|
||||||
|
- Microsoft Edge
|
||||||
|
- Firefox
|
||||||
|
- Opera
|
||||||
|
- Safari
|
||||||
|
- Other (Specify below)
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Version
|
||||||
|
description: What version were you using?
|
||||||
|
placeholder: ex. 0.4.1
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "## Describe the issue."
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "### Please do not report issues from other engines. These must be reported in their repositories."
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: "#### Provide as many details as you can."
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Context (Provide images, videos, etc. of the crash happening)
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Crash Logs (can be found in the crash folder)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
8
.github/ISSUE_TEMPLATE/enhancement.md
vendored
8
.github/ISSUE_TEMPLATE/enhancement.md
vendored
|
|
@ -1,8 +0,0 @@
|
||||||
---
|
|
||||||
name: Enhancement
|
|
||||||
about: Suggest a new feature
|
|
||||||
title: 'Enhancement: '
|
|
||||||
labels: 'status: pending triage'
|
|
||||||
---
|
|
||||||
#### Please check for duplicates or similar issues before submitting this suggestion.
|
|
||||||
## What is your suggestion, and why should it be implemented?
|
|
||||||
15
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
Normal file
15
.github/ISSUE_TEMPLATE/enhancement.yml
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
name: Enhancement
|
||||||
|
description: Suggest a new feature
|
||||||
|
labels: ["type: enhancement", "status: pending triage"]
|
||||||
|
title: "Enhancement: "
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Issue Checklist
|
||||||
|
options:
|
||||||
|
- label: I have properly named the issue
|
||||||
|
- label: I looked in issues/discussions, if it has been previously reported
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: What is your suggestion, and why should it be implemented?
|
||||||
10
.github/PULL_REQUEST_TEMPLATE/enhancement.md
vendored
10
.github/PULL_REQUEST_TEMPLATE/enhancement.md
vendored
|
|
@ -1,10 +0,0 @@
|
||||||
---
|
|
||||||
name: Enhancement
|
|
||||||
about: Add a new feature
|
|
||||||
title: 'Enhancement: '
|
|
||||||
labels: 'status: pending triage'
|
|
||||||
---
|
|
||||||
#### Please check for duplicates or similar PRs before submitting this PR.
|
|
||||||
## Does this PR close any issues? If so, link them below.
|
|
||||||
|
|
||||||
## What do your changes add, and why should they be implemented?
|
|
||||||
Loading…
Reference in a new issue