Skip to content

Commit

Permalink
chore: replace issue templates with forms
Browse files Browse the repository at this point in the history
  • Loading branch information
bastimeyer committed Jul 11, 2021
1 parent 414cdfc commit fbbe5d5
Show file tree
Hide file tree
Showing 7 changed files with 140 additions and 176 deletions.
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Bug report
description: Something is broken or not working as intended
body:
- type: markdown
attributes:
value: |
## Thanks for reporting a bug!
Bugs are the result of broken functionality within the code base of Streamlink Twitch GUI.
Remember that Streamlink Twitch GUI is just a launcher for Streamlink, so any issues related to streaming via Streamlink itself or the stream output in the chosen video player do not belong on this issue tracker.
**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: I understand that **Streamlink Twitch GUI** is just a launcher for **Streamlink**
required: true
- label: "[I have read the contribution guidelines](https://github.com/streamlink/streamlink-twitch-gui/blob/master/CONTRIBUTING.md)"
required: true
- label: "[I have checked the list of open and recently closed issues](https://github.com/streamlink/streamlink-twitch-gui/issues?q=is%3Aissue+sort%3Aupdated-desc)"
required: true
- label: "[I have checked the commit log of the master branch](https://github.com/streamlink/streamlink-twitch-gui/commits/master)"
required: true
- type: input
attributes:
label: Streamlink Twitch GUI version
description: |
[Only the **latest stable release** or **latest build from the master branch** will be accepted.](https://github.com/streamlink/streamlink-twitch-gui#download)
The exact version string can be found in the application's "About" menu.
placeholder: "eg. v1.11.0 or v1.11.0+62.g414cdfc1"
validations:
required: true
- type: input
attributes:
label: Streamlink version
description: |
Bugs related to launching streams require the Streamlink version in use.
Run `streamlink --version` from the command line shell to see the exact version string.
If you have set a custom Streamlink path in the streaming settings menu, then you will need to adjust the Streamlink path in the shell as well.
placeholder: "eg. 2.2.0 or 2.2.0+32.g1b517c7"
- type: textarea
attributes:
label: Operating system, environment and configuration details
description: |
Anything useful for the developers to understand your system's environment and the application's configuration.
placeholder: |
eg. Windows 10 21H1, macOS 10.15 Catalina, Ubuntu 20.04 LTS, Arch Linux, etc.
validations:
required: true
- type: textarea
attributes:
label: Description
description: |
Explain the bug as thoroughly as you can.
Don't leave out information which is necessary for the developers to fully understand the problem and don't forget to list reproduction steps.
validations:
required: true
- type: textarea
attributes:
label: Debug log
description: |
Depending on the bug, debug text log output may be useful.
Use Streamlink Twitch GUI's [`--loglevel debug`](https://github.com/streamlink/streamlink-twitch-gui/wiki/Parameters) parameter.
Make sure to **remove usernames, passwords and tokens**
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
- 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 Twitch GUI? Please consider supporting its developer. Thanks!](https://github.com/streamlink/streamlink-twitch-gui#support)
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Feature request
description: Suggest a new feature
body:
- type: markdown
attributes:
value: |
## Thanks for filing a feature request!
**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: I understand that **Streamlink Twitch GUI** is just a launcher for **Streamlink**
required: true
- label: "[I have read the contribution guidelines](https://github.com/streamlink/streamlink-twitch-gui/blob/master/CONTRIBUTING.md)"
required: true
- label: "[I have checked the list of open and recently closed issues](https://github.com/streamlink/streamlink-twitch-gui/issues?q=is%3Aissue+sort%3Aupdated-desc)"
required: true
- label: "[I have checked the commit log of the master branch](https://github.com/streamlink/streamlink-twitch-gui/commits/master)"
required: true
- type: textarea
attributes:
label: Description
description: |
Explain the feature as clearly as you can.
What is it?
How would you expect it to work?
What value does it bring to Streamlink Twitch GUI?
Is it supported by the [Twitch API](https://dev.twitch.tv/docs/)?
Does it fit into the scope and aims of the project?
etc.
validations:
required: true
- type: markdown
attributes:
value: |
### Before submitting
Make sure that you have
- properly filled in the title of this feature request
- checked the rendered text previews to avoid unnecessary formatting errors
----
[Love Streamlink Twitch GUI? Please consider supporting its developer. Thanks!](https://github.com/streamlink/streamlink-twitch-gui#support)
79 changes: 0 additions & 79 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
blank_issues_enabled: true
blank_issues_enabled: false
contact_links:
- name: "Streamlink"
about: "This is the Streamlink Twitch GUI repository. Anything Streamlink related belongs on the Streamlink repository."
Expand All @@ -12,3 +12,6 @@ contact_links:
- name: "Gitter channel"
about: "Get in touch with other Streamlink Twitch GUI users."
url: https://gitter.im/streamlink/streamlink-twitch-gui
- name: "Matrix channel (Gitter bridge)"
about: "Get in touch with other Streamlink Twitch GUI users."
url: https://matrix.to/#/#streamlink_streamlink-twitch-gui:gitter.im
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

60 changes: 0 additions & 60 deletions .github/issue_template.md

This file was deleted.

3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Please read the following guidelines before you [report an issue][issues]:

3. **Isolate the demonstrable problem** — make sure that the code in the project's repository is *definitely* responsible for the issue.

Please try to be as detailed as possible in your report too. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to assess and fix any potential bugs. You can also consider using the [issue template][issue-template] when reporting an issue.
Please try to be as detailed as possible in your report too. What is your environment? What steps will reproduce the issue? What would you expect to be the outcome? All these details will help people to assess and fix any potential bugs.


## Feature requests
Expand Down Expand Up @@ -176,7 +176,6 @@ This contributing guide has been adapted from [HTML5 boilerplate's guide][ref-h5

[license]: https://github.com/streamlink/streamlink-twitch-gui/blob/master/LICENSE
[issues]: https://github.com/streamlink/streamlink-twitch-gui/issues
[issue-template]: https://github.com/streamlink/streamlink-twitch-gui/blob/master/ISSUE_TEMPLATE.md
[wiki]: https://github.com/streamlink/streamlink-twitch-gui/wiki
[howto-fork]: https://help.github.com/articles/fork-a-repo
[howto-rebase]: https://help.github.com/articles/interactive-rebase
Expand Down

0 comments on commit fbbe5d5

Please sign in to comment.