Skip to content

Commit

Permalink
use GitHub issue forms for opening issues
Browse files Browse the repository at this point in the history
  • Loading branch information
nofishonfriday committed Feb 4, 2022
1 parent 4ca0494 commit fd8afef
Show file tree
Hide file tree
Showing 2 changed files with 131 additions and 0 deletions.
86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: Bug report
description: Create a bug report to help us improve
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this issue! :hugs:
However note the following before opening an issue:
* IF YOU DON'T FILL IN THE TEMPLATE PROPERLY, YOUR ISSUE IS LIABLE TO BE CLOSED.
* If you feel tired/lazy right now, open your issue some other time. We'll wait.
- type: checkboxes
id: checklist
attributes:
label: "Checklist"
options:
- label: "I am able to reproduce the bug with the [latest version](https://www.sws-extension.org/)"
required: true
- label: "I checked, but didn't find any duplicates ([open](https://github.com/reaper-oss/sws/issues) OR [closed](https://github.com/reaper-oss/sws/issues?q=is%3Aissue+is%3Aclosed)) of this issue in the repo"
required: true
- label: "This issue contains only one bug. I will open one issue for every bug report I want to file."
required: true

- type: input
id: version
attributes:
label: Affected version
description: "What version are you currently using?"
placeholder: "x.xx.x #x - Can be seen in REAPER > Extensions > About SWS Extension"
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce the bug
description: |
What did you do that the bug shows up?
If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug.
placeholder: |
1.
2.
3.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: |
Tell us what you expect to happen.
- type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: |
Tell us what happens with the steps given above.
- type: textarea
id: screen-media
attributes:
label: Screenshots/Screen recordings
description: |
A picture or video is worth a thousand words.
If applicable, add screenshots or a screen recording to help explain your problem.
GitHub supports uploading them directly in the text box.
If your file is too big for Github to accept, try to compress it (ZIP-file) or feel free to paste a link from an image/video hoster here instead.
- type: textarea
id: logs
attributes:
label: Logs
description: |
If your bug includes a crash, try to provide a [crash log](https://forum.cockos.com/showthread.php?t=36653).
- type: textarea
id: system-info
attributes:
label: REAPER / System information
value: |
- REAPER version:
- Operating system:
- type: textarea
id: additional-information
attributes:
label: Additional information
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Feature request
description: Suggest an idea for this project
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this issue! :hugs:
However note the following before opening an issue:
* IF YOU DON'T FILL IN THE TEMPLATE PROPERLY, YOUR ISSUE IS LIABLE TO BE CLOSED.
* If you feel tired/lazy right now, open your issue some other time. We'll wait.
- type: checkboxes
id: checklist
attributes:
label: "Checklist"
options:
- label: "I checked, but didn't find any duplicates ([open]([open](https://github.com/reaper-oss/sws/issues) OR [closed](https://github.com/reaper-oss/sws/issues?q=is%3Aissue+is%3Aclosed)) of this issue in the repo"
required: true
- label: "This issue contains only one feature request. I will open one issue for every feature I want to request."
required: true


- type: textarea
id: what-feature-is-requested
attributes:
label: What feature do you want?
description: |
Explain how you want the SWS Extension look or behavior to change to suit your needs.
validations:
required: true

- type: textarea
id: why-is-the-feature-requested
attributes:
label: Why do you want this feature?
description: |
Describe any problem or limitation you come across while using the app which would be solved by this feature.
validations:
required: true

- type: textarea
id: additional-information
attributes:
label: Additional information

0 comments on commit fd8afef

Please sign in to comment.