streamlink/.github/ISSUE_TEMPLATE/2_bug_report.yml

77 lines
3.2 KiB
YAML

name: Bug Report
description: A core functionality of Streamlink is broken
title: "A very brief summary of what's broken"
labels:
- bug
body:
- type: markdown
attributes:
value: |
## Thanks for reporting a bug!
Bugs are the result of broken functionality within Streamlink's main code base. Use the plugin issue template if your report is about a broken plugin.
**DON'T IGNORE this template and fill in all the required details.**
**Issues that don't adhere to our request will be closed and ignored.**
This is because analyzing bugs, issues or requests without proper details and log output is harder than necessary.
Low quality and low effort issues are noise and steal the time of the maintainers and contributors.
- type: checkboxes
attributes:
label: Checklist
options:
- label: This is a bug report and not a different kind of issue
required: true
- label: "[I have read the contribution guidelines](https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md#contributing-to-streamlink)"
required: true
- label: "[I have checked the list of open and closed plugin issues](https://github.com/streamlink/streamlink/issues?q=is%3Aissue+label%3A%22bug%22)"
required: true
- label: "[I have checked the commit log of the master branch](https://github.com/streamlink/streamlink/commits/master)"
required: true
- type: dropdown
attributes:
label: Streamlink version
description: |
[Only the **latest stable release** or **latest build from the master branch** will be accepted.](https://streamlink.github.io/install.html)
The mandatory debug log down below still needs to include the explicit version string.
options:
- Latest stable release
- Latest build from the master branch
validations:
required: true
- type: textarea
attributes:
label: Description
description: |
Explain the bug as thoroughly as you can.
Please also provide the exact steps for reproducing the issue.
validations:
required: true
- type: textarea
attributes:
label: Debug log
description: |
DEBUG LOG OUTPUT IS REQUIRED for bug reports!
INCLUDE THE ENTIRE COMMAND LINE and make sure to **remove usernames and passwords**
Use the [`--loglevel debug`](https://streamlink.github.io/latest/cli.html#cmdoption-loglevel) parameter and avoid using parameters which suppress log output.
Debug log includes important details about your platform. Don't remove it.
placeholder: |
Don't post screenshots of the log output and instead copy the text from your terminal application.
The content will be rendered as code block.
render: text
validations:
required: true
- type: markdown
attributes:
value: |
### Before submitting
Make sure that you have
- properly filled in the title of this bug report
- checked the rendered text previews to avoid unnecessary formatting errors
----
[Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate)