Add updated issue templates

This commit is contained in:
Nathan Thomas 2021-09-15 21:39:16 -07:00
parent 579ffefb84
commit e58250f033
2 changed files with 110 additions and 0 deletions

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

@ -0,0 +1,87 @@
name: 🐛 Bug Report
description: Create a report to help us improve streamrip
labels: bug
title: "[BUG] <title>"
body:
# types: dropdown, textarea, input
# - type: dropdown
# validations:
# required: true
# attributes:
# label: Are you using "tree-sitter" branch?
# options:
# - 'Yes'
# - 'No'
- type: textarea
validations:
required: true
attributes:
label: Describe the bug
description: A clear and concise description of the bug.
- type: textarea
validations:
required: true
attributes:
label: Command Used
description: |
The command that you typed that caused the error
placeholder: |
For example:
`rip url https://example.com`
render: "bash"
- type: textarea
validations:
required: true
attributes:
label: Debug Traceback
description: |
Run your command, with `-vvv` appended to it, and paste the output here.
For example, if the problematic command was `rip url https://example.com`, then
you would run `rip url https://example.com -vvv` to get the debug logs.
Make sure to check the logs for any personal information such as emails and remove them.
render: "text"
- type: textarea
validations:
required: true
attributes:
label: Config File
description: |
Find the config file using `rip config --open` and paste the contents here.
Make sure you REMOVE YOUR CREDENTIALS!
render: toml
- type: input
validations:
required: true
attributes:
label: Operating System
placeholder: e.g. Windows, Linux, macOS...
- type: input
validations:
required: true
attributes:
label: streamrip version
description: Run `rip --version` to check.
placeholder: e.g. 1.5
render: "text"
- type: textarea
attributes:
label: Screenshots and recordings
description: |
If applicable, add screenshots to help explain your problem.
You can also record an asciinema session: https://asciinema.org/
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
- type: markdown
attributes:
value: "Thanks for completing our form!"

View File

@ -0,0 +1,23 @@
name: 🚀 Feature Request
description: Suggest a feature that would improve streamrip
labels: enhancement
title: "[FEATURE] <title>"
body:
- type: textarea
validations:
required: true
attributes:
label: Is the feature request related to a problem. Please describe it.
description: e.g. I have an issue when...
- type: textarea
validations:
required: true
attributes:
label: Describe the solution you would like.
description: A clear and concise description of what you want to happen. Add any considered drawbacks.
- type: textarea
attributes:
label: Describe alternatives you've considered.
description: A clear and concise description of any alternative solutions or features you've considered.