diff --git a/.github/ISSUE_TEMPLATE/0_use_the_issue_template.md b/.github/ISSUE_TEMPLATE/0_use_the_issue_template.md deleted file mode 100644 index f442942e..00000000 --- a/.github/ISSUE_TEMPLATE/0_use_the_issue_template.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: CHOOSE ONE OF THE ISSUE TEMPLATES LISTED BELOW -about: DON'T IGNORE OR REMOVE THE TEMPLATE. EXCLUDING TEMPLATE DATA WILL RESULT IN THE ISSUE BEING CLOSED. ---- - -**Please choose one of the issue templates listed on the previous page:** -https://github.com/streamlink/streamlink/issues/new/choose - -Don't ignore the template and read before filling out all the required informations. - -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. diff --git a/.github/ISSUE_TEMPLATE/1_plugin_issue.md b/.github/ISSUE_TEMPLATE/1_plugin_issue.md deleted file mode 100644 index 31b7ac46..00000000 --- a/.github/ISSUE_TEMPLATE/1_plugin_issue.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -name: Plugin Issue -about: One of Streamlink's plugins doesn't work correctly -title: "plugins.plugin-name-here: A very brief summary of what's broken" -labels: plugin issue ---- - - - - -## Plugin Issue - - -- [ ] This is a plugin issue and I have read the contribution guidelines. -- [ ] I am using the latest development version from the master branch. - - -### Description - - - - -### Reproduction steps / Explicit stream URLs to test - - - -1. ... -2. ... -3. ... - - -### Log output - - - -``` -REPLACE THIS TEXT WITH THE LOG OUTPUT -All log output should go between two blocks of triple backticks (grave accents) for proper formatting. -``` - - -### Additional comments, etc. - - - -[Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/.github/ISSUE_TEMPLATE/1_plugin_issue.yml b/.github/ISSUE_TEMPLATE/1_plugin_issue.yml new file mode 100644 index 00000000..5487c0dc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_plugin_issue.yml @@ -0,0 +1,76 @@ +name: Plugin issue +description: One of Streamlink's plugins doesn't work correctly +title: "plugins.plugin-name-here: A very brief summary of what's broken" +labels: + - plugin issue +body: + - type: markdown + attributes: + value: | + ## Thanks for reporting a plugin issue! + + Plugin issues describe broken functionality within a plugin's code base, eg. the streaming site has made breaking changes, streams don't get resolved correctly, or authentication has stopped working, etc. + + **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 plugin issue 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%22plugin+issue%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 plugin issue as thoroughly as you can. + Please also provide the exact steps for reproducing the issue, eg. a list of input URLs. + validations: + required: true + - type: textarea + attributes: + label: Debug log + description: | + DEBUG LOG OUTPUT IS REQUIRED for plugin issues! + 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 plugin issue + - checked the rendered text previews to avoid unnecessary formatting errors + + ---- + + [Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/.github/ISSUE_TEMPLATE/1_plugin_request.md b/.github/ISSUE_TEMPLATE/1_plugin_request.md deleted file mode 100644 index 32082387..00000000 --- a/.github/ISSUE_TEMPLATE/1_plugin_request.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Plugin Request -about: Discuss adding a new plugin to Streamlink -title: "Name of the website / streaming provider" -labels: plugin request ---- - - - - -## Plugin Request - - -- [ ] This is a plugin request and I have read the contribution guidelines and plugin request requirements. -- [ ] I am using the latest development version from the master branch. - - -### Description - - - - -### Example stream URLs - - - -1. ... -2. ... -3. ... - - -### Additional comments, etc. - - - -[Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/.github/ISSUE_TEMPLATE/1_plugin_request.yml b/.github/ISSUE_TEMPLATE/1_plugin_request.yml new file mode 100644 index 00000000..c959c00c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_plugin_request.yml @@ -0,0 +1,63 @@ +name: Plugin request +description: Discuss adding a new plugin to Streamlink +title: "Name of the website / streaming provider" +labels: + - plugin request +body: + - type: markdown + attributes: + value: | + ## Thanks for requesting a plugin! + + [READ THE PLUGIN REQUEST REQUIREMENTS IN THE CONTRIBUTION GUIDELINES BEFORE POSTING!](https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md#plugin-requests) + + **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 plugin request 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 requests](https://github.com/streamlink/streamlink/issues?q=is%3Aissue+label%3A%22plugin+request%22)" + required: true + - type: textarea + attributes: + label: Description + description: | + Explain the plugin and site as clearly as you can. + + What is the site about? + Who is it run by? + What content does it provide? + etc. + validations: + required: true + - type: textarea + attributes: + label: Input URLs + description: | + Please provide a list of example stream input URLs + placeholder: | + 1. ... + 2. ... + 3. ... + etc. + validations: + required: true + - type: markdown + attributes: + value: | + ### Before submitting + + Make sure that you have + - properly filled in the title of this plugin request + - checked the rendered text previews to avoid unnecessary formatting errors + + ---- + + [Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/.github/ISSUE_TEMPLATE/2_bug_report.md b/.github/ISSUE_TEMPLATE/2_bug_report.md deleted file mode 100644 index ba7f42a7..00000000 --- a/.github/ISSUE_TEMPLATE/2_bug_report.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -name: Bug Report -about: A core functionality of Streamlink is broken -title: "A very brief summary of what's broken" -labels: bug ---- - - - - -## Bug Report - - -- [ ] This is a bug report and I have read the contribution guidelines. -- [ ] I am using the latest development version from the master branch. - - -### Description - - - - -### Expected / Actual behavior - - - - -### Reproduction steps / Explicit stream URLs to test - - - -1. ... -2. ... -3. ... - - -### Log output - - - -``` -REPLACE THIS TEXT WITH THE LOG OUTPUT -All log output should go between two blocks of triple backticks (grave accents) for proper formatting. -``` - - -### Additional comments, etc. - - - -[Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/.github/ISSUE_TEMPLATE/2_bug_report.yml b/.github/ISSUE_TEMPLATE/2_bug_report.yml new file mode 100644 index 00000000..9e3d39a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_bug_report.yml @@ -0,0 +1,76 @@ +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) diff --git a/.github/ISSUE_TEMPLATE/3_feature_request.md b/.github/ISSUE_TEMPLATE/3_feature_request.md deleted file mode 100644 index 437a7f0d..00000000 --- a/.github/ISSUE_TEMPLATE/3_feature_request.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Feature Request -about: Discuss adding new functionality to Streamlink -title: "A very brief summary of your request" -labels: feature request ---- - - - - -## Feature Request - - -- [ ] This is a feature request and I have read the contribution guidelines. -- [ ] I am using the latest development version from the master branch. - - -### Description - - - - - -### Additional comments, etc. - - - -[Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/.github/ISSUE_TEMPLATE/3_feature_request.yml b/.github/ISSUE_TEMPLATE/3_feature_request.yml new file mode 100644 index 00000000..ea7778b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_feature_request.yml @@ -0,0 +1,52 @@ +name: Feature request +description: Discuss adding new functionality to Streamlink +title: "A very brief summary of your request" +labels: + - feature request +body: + - type: markdown + attributes: + value: | + ## Thanks for filing a feature request! + + Open a plugin request if you're requesting a new plugin instead of a new feature. + + **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 feature request 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 requests](https://github.com/streamlink/streamlink/issues?q=is%3Aissue+label%3A%22feature+request%22)" + 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? + 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? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 592dc4ba..349b7c45 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: "Help" about: "The issue tracker is only meant for bug reports, feature/plugin requests and plugin issues. Please ask your questions on the discussions forum and look for already existing answers." @@ -9,3 +9,6 @@ contact_links: - name: "Gitter channel" about: "Get in touch with other Streamlink users." url: https://gitter.im/streamlink/streamlink + - name: "Matrix channel (Gitter bridge)" + about: "Get in touch with other Streamlink users." + url: https://matrix.to/#/#streamlink_streamlink:gitter.im diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index c3ae8d05..00000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,70 +0,0 @@ - - - -## Issue - - -- [ ] This is not a bug report, feature request, or plugin issue/request. -- [ ] I have read the contribution guidelines. -- [ ] I am using the latest development version from the master branch. - - -### Description - - - - -### Expected / Actual behavior - - - - -### Reproduction steps / Explicit stream URLs to test - - - -1. ... -2. ... -3. ... - - -### Log output - - - -``` -REPLACE THIS TEXT WITH THE LOG OUTPUT -All log output should go between two blocks of triple backticks (grave accents) for proper formatting. -``` - - -### Additional comments, etc. - - - -[Love Streamlink? Please consider supporting our collective. Thanks!](https://opencollective.com/streamlink/donate) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9ba3e6ed..8b5a51d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ Please read the following guidelines before you [report an issue][issues]: 5. **Format your issue report** — [well formatted texts][mastering-markdown] will make it much easier for developers to understand your report. -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 the outcome to be? All these details will help people to assess and fix any potential bugs. The [issue template][issue-template] will aid you in structuring your report when submitting a new issue. If your report includes log output, please provide it as text in multi-line code blocks if possible for better readability. Thank you! +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 the outcome to be? All these details will help people to assess and fix any potential bugs. The various issue templates will aid you in structuring your report when submitting a new issue. Thank you! ## Feature requests @@ -111,7 +111,6 @@ This contributing guide has been adapted from [HTML5 boilerplate's guide][ref-h5 [issues]: https://github.com/streamlink/streamlink/issues [known-issues]: https://github.com/streamlink/streamlink/blob/master/KNOWN_ISSUES.md - [issue-template]: https://github.com/streamlink/streamlink/blob/master/ISSUE_TEMPLATE.md [mastering-markdown]: https://guides.github.com/features/mastering-markdown [howto-fork]: https://help.github.com/articles/fork-a-repo [howto-rebase]: https://help.github.com/articles/interactive-rebase