mirror of
https://github.com/nathom/streamrip.git
synced 2025-05-13 14:44:49 -04:00
Use YAML for bug report template
This commit is contained in:
parent
c4824e875f
commit
e8b897d0ce
2 changed files with 64 additions and 58 deletions
58
.github/ISSUE_TEMPLATE/bug_report.md
vendored
58
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,58 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F41B Bug Report"
|
|
||||||
about: "If something isn't working as expected \U0001F914."
|
|
||||||
title: 'Bug: Your Title'
|
|
||||||
labels: bug
|
|
||||||
assignees: nathom
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Bug Report
|
|
||||||
|
|
||||||
**Current Behavior**
|
|
||||||
A clear and concise description of the behavior.
|
|
||||||
|
|
||||||
**Command used:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
Type the command that caused the bug here
|
|
||||||
```
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**`streamrip` Configuration File (find using `rip config -o`):**
|
|
||||||
|
|
||||||
<!-- If the command isn't working, you can find the file at one of the following paths:-->
|
|
||||||
|
|
||||||
<!-- macOS: ~/Library/Application Support/streamrip -->
|
|
||||||
|
|
||||||
<!-- Linux: ~/.config/streamrip or ~/.streamrip -->
|
|
||||||
|
|
||||||
<!-- Windows: \Users\<username>\AppData\Local\streamrip or C:\Users\<usename>\AppData\Roaming\streamrip-->
|
|
||||||
|
|
||||||
|
|
||||||
```toml
|
|
||||||
# Paste the contents of config.toml here
|
|
||||||
# REMOVE YOUR CREDENTIALS
|
|
||||||
[your]
|
|
||||||
config = "file"
|
|
||||||
```
|
|
||||||
|
|
||||||
**Environment**
|
|
||||||
|
|
||||||
- `streamrip` version(s): [e.g. v0.5.2]
|
|
||||||
- Python version: [e.g. 3.8]
|
|
||||||
- OS: [e.g. OSX 10.13.4, Windows 10]
|
|
||||||
|
|
||||||
**Traceback**
|
|
||||||
```bash
|
|
||||||
# Paste the text that Python dumped on the error here
|
|
||||||
# Delete this section if there was no traceback
|
|
||||||
```
|
|
||||||
|
|
||||||
**Possible Solution**
|
|
||||||
<!--- Only if you have suggestions on a fix for the bug. Otherwise, delete this section. -->
|
|
||||||
|
|
||||||
**Additional context/Screenshots**
|
|
||||||
Add any other context about the problem here. If applicable, add screenshots to help explain.
|
|
64
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
64
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
@ -0,0 +1,64 @@
|
||||||
|
name: Bug report
|
||||||
|
blank_issues_enabled: false
|
||||||
|
description: Create a report to help us improve streamrip
|
||||||
|
labels: bug
|
||||||
|
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`
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Traceback
|
||||||
|
description: If there was any error output, paste it here
|
||||||
|
|
||||||
|
- 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: input
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: Operating System
|
||||||
|
placeholder: e.g. Windows 10, Ubuntu 20.04, Arch Linux, macOS 10.15...
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
attributes:
|
||||||
|
label: streamrip version
|
||||||
|
description: Run `rip --version` to check.
|
||||||
|
placeholder: e.g. 1.5
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
description: Add any other context about the problem here.
|
Loading…
Add table
Add a link
Reference in a new issue