Reword+reformat issue templates for consistency #1966
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #1966 +/- ##
==========================================
- Coverage 51.34% 51.33% -0.02%
==========================================
Files 242 242
Lines 14302 14311 +9
==========================================
+ Hits 7344 7347 +3
- Misses 6958 6964 +6 |
back-to
approved these changes
Jul 27, 2018
gravyboat
requested changes
Jul 27, 2018
Member
gravyboat
left a comment
There was a problem hiding this comment.
Looks pretty good to me @bastimeyer. I added a few notes about some grammatical concerns but overall I like the changes, nice job.
.github/ISSUE_TEMPLATE/Bug_Report.md
Outdated
| ### Description | ||
|
|
||
| <!-- Explain the bug as clearly as you can. How is functionality impacted? Which OS/Player/Streamlink version are you using? Etc. --> | ||
| <!-- Explain the bug as detailed as you can. --> |
Member
There was a problem hiding this comment.
Grammatically this is a weird sentence, maybe something like Explain the bug as thoroughly as you can? Also since we're dropping the requirement of player and such does this open us up to fewer details? Granted people weren't doing it any way...
Member
Author
There was a problem hiding this comment.
"thoroughly" is better here, there's no real adverb of "detailed"... what a weird language
The log output already requires this information, so I left it out. But yeah, you've got a point here
| Make sure to **remove username and password** | ||
| <!-- | ||
| TEXT LOG OUTPUT IS REQUIRED for a bug report! | ||
| Use the `--loglevel debug` parameter and avoid using parameters which suppress log output. |
Member
There was a problem hiding this comment.
Should we add an example of what the streamlink command looks like when running with -l debug here? Some people have been confused about this lately.
Member
Author
There was a problem hiding this comment.
I think that would make it a bit too long
| https://github.com/streamlink/streamlink/blob/master/CONTRIBUTING.md#contributing-to-streamlink | ||
| Please fill out the following template. Be as detailed as possible. | ||
| Open a plugin request, if you're requesting a new plugin instead of a new feature. |
.github/ISSUE_TEMPLATE/Bug_Report.md
Outdated
|
|
||
| <!-- | ||
| Thanks for reporting a bug! | ||
| USE THE TEMPLATE, otherwise, your bug report may be rejected. |
Member
There was a problem hiding this comment.
I don't think we need these commas.
Member
Author
There was a problem hiding this comment.
Before I change this, does
"USE THE TEMPLATE! Otherwise your bug report may be rejected."
sound better? The exclamation mark may sound a bit harsh.
Member
There was a problem hiding this comment.
I'd avoid the exclamation mark, I agree it sounds harsh.
|
|
||
| <!-- | ||
| Thanks for filing a feature request! | ||
| USE THE TEMPLATE, otherwise, your feature request may be rejected. |
Member
There was a problem hiding this comment.
Same as the other one, I don't think we need these commas.
|
|
||
| <!-- | ||
| Thanks for reporting a plugin issue! | ||
| USE THE TEMPLATE, otherwise, your plugin issue may be rejected. |
Member
There was a problem hiding this comment.
Same as before, don't think we need these commas.
| ### Description | ||
|
|
||
| <!-- Explain the plugin issue as clearly as you can. Which plugin is causing isuses? what exactly is the issue? Etc. --> | ||
| <!-- Explain the plugin issue as detailed as you can. --> |
Member
There was a problem hiding this comment.
Similarly to above the grammar here is weird. I think my proposal from earlier would resolve this, otherwise we can do something else.
|
|
||
| <!-- | ||
| Thanks for requesting a plugin! | ||
| USE THE TEMPLATE, otherwise, your plugin request may be rejected. |
Member
|
What do you think about creating closed example issues and linking them? Is that adding too much or overwhelming? At the very least I think we should have examples to link when someone asks about them but those don't need to be part of this. |
Member
Author
I'm not really a fan of this idea. Let's just wait and see what these changes will do. |
Member
|
These changes look good to me |
gravyboat
approved these changes
Jul 27, 2018
Member
|
@bastimeyer I'm not really a fan of the closed example issues either, but I'm getting pretty tired of people asking "well what should my issue look like?" when it doesn't meet the requirements simply because they didn't read when they opened the issue initially. |
Member
Author
|
We could add something to the repo wiki or repo itself and then link to it. Example issue threads would get spammed with (bad) references. |
Member
|
@bastimeyer Hmm yeah that's a good point, I think the mentions pop through even if you lock an issue don't they? |
Member
|
I'm going to merge this. We can always open a new issue if we want to discuss things further. Thanks @bastimeyer! |
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Apr 1, 2020
streamlink 1.3.1 (2020-01-27)
A small patch release that addresses the removal of MPV's legacy option syntax, also with fixes of several plugins, the addition of the --twitch-disable-reruns parameter and dropped support for Python 3.4.
streamlink 1.3.0 (2019-11-22)
A new release with plugin updates and fixes, including Twitch.tv (see #2680), which had to be delayed due to back and forth API changes.
The Twitch.tv workarounds mentioned in #2680 don't have to be applied anymore, but authenticating via --twitch-oauth-token has been disabled, regardless of the origin of the OAuth token (via --twitch-oauth-authenticate or the Twitch website). In order to not introduce breaking changes, both parameters have been kept in this release and the user name will still be logged when using an OAuth token, but receiving item drops or accessing restricted streams is not possible anymore.
Plugins for the following sites have also been added:
albavision
news.now.com
twitcasting.tv
viu.tv
vlive.tv
willax.tv
streamlink 1.2.0 (2019-08-18)
Here are the changes for this month's release
Multiple plugin fixes
Fixed single hyphen params at the beginning of --player-args (#2333)
--http-proxy will set the default value of --https-proxy to same as --http-proxy. (#2536)
DASH Streams will handle headers correctly (#2545)
the timestamp for FFMPEGMuxer streams will start with zero (#2559)
streamlink 1.1.1 (2019-04-02)
This is just a small patch release which fixes a build/deploy issue with the new special wheels for Windows on PyPI. (#2392)
streamlink 1.0.0 (2019-01-30)
The celebratory release of Streamlink 1.0.0!
A lot of hard work has gone into getting Streamlink to where it is. Not only is Streamlink used across multiple applications and platforms, but companies as well.
Streamlink started from the inaugural fork of Livestreamer on September 17th, 2016.
Since then, We've hit multiple milestones:
Over 886 PRs
Hit 3,000 commits in Streamlink
Obtaining our first sponsors as well as backers of the project
The creation of our own logo (streamlink/streamlink#1123)
Thanks to everyone who has contributed to Streamlink (and our backers)! Without you, we wouldn't be where we are today.
Without further ado, here are the changes in release 1.0.0:
We have a new icon / logo for Streamlink! (streamlink/streamlink#2165)
Updated dependencies (streamlink/streamlink#2230)
A ton of plugin updates. Have a look at this search query for all the recent updates.
You can now provide a custom key URI to override HLS streams (streamlink/streamlink#2139). For example: --hls-segment-key-uri <URI>
User agents for API communication have been updated (streamlink/streamlink#2194)
Special synonyms have been added to sort "best" and "worst" streams (streamlink/streamlink#2127). For example: streamlink --stream-sorting-excludes '>=480p' URL best,best-unfiltered
Process output will no longer show if tty is unavailable (streamlink/streamlink#2090)
We've removed BountySource in favour of our OpenCollective page. If you have any features you'd like to request, please open up an issue with the request and possibly consider backing us!
Improved terminal progress display for wide characters (streamlink/streamlink#2032)
Fixed a bug with dynamic playlists on playback (streamlink/streamlink#2096)
Fixed makeinstaller.sh (streamlink/streamlink#2098)
Old Livestreamer deprecations and API references were removed (streamlink/streamlink#1987)
Dependencies have been updated for Python (streamlink/streamlink#1975)
Newer and more common User-Agents are now used (streamlink/streamlink#1974)
DASH stream bitrates now round-up to the nearest 10, 100, 1000, etc. (streamlink/streamlink#1995)
Updated documentation on issue templates (streamlink/streamlink#1996)
URL have been added for better processing of HTML tags (streamlink/streamlink#1675)
Fixed sort and prog issue (streamlink/streamlink#1964)
Reformatted issue templates (streamlink/streamlink#1966)
Fixed crashing bug with player-continuous-http option (streamlink/streamlink#2234)
Make sure all dev dependencies (streamlink/streamlink#2235)
-r parameter has been replaced for --rtmp-rtmpdump (streamlink/streamlink#2152)
Breaking changes:
A large number of unmaintained or NSFW plugins have been removed. You can find the PR that implemented that change here: streamlink/streamlink#2003 . See our CONTRIBUTING.md documentation for plugin policy.
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Apr 6, 2020
streamlink 1.3.1 (2020-01-27)
A small patch release that addresses the removal of MPV's legacy option syntax, also with fixes of several plugins, the addition of the --twitch-disable-reruns parameter and dropped support for Python 3.4.
streamlink 1.3.0 (2019-11-22)
A new release with plugin updates and fixes, including Twitch.tv (see #2680), which had to be delayed due to back and forth API changes.
The Twitch.tv workarounds mentioned in #2680 don't have to be applied anymore, but authenticating via --twitch-oauth-token has been disabled, regardless of the origin of the OAuth token (via --twitch-oauth-authenticate or the Twitch website). In order to not introduce breaking changes, both parameters have been kept in this release and the user name will still be logged when using an OAuth token, but receiving item drops or accessing restricted streams is not possible anymore.
Plugins for the following sites have also been added:
albavision
news.now.com
twitcasting.tv
viu.tv
vlive.tv
willax.tv
streamlink 1.2.0 (2019-08-18)
Here are the changes for this month's release
Multiple plugin fixes
Fixed single hyphen params at the beginning of --player-args (#2333)
--http-proxy will set the default value of --https-proxy to same as --http-proxy. (#2536)
DASH Streams will handle headers correctly (#2545)
the timestamp for FFMPEGMuxer streams will start with zero (#2559)
streamlink 1.1.1 (2019-04-02)
This is just a small patch release which fixes a build/deploy issue with the new special wheels for Windows on PyPI. (#2392)
streamlink 1.0.0 (2019-01-30)
The celebratory release of Streamlink 1.0.0!
A lot of hard work has gone into getting Streamlink to where it is. Not only is Streamlink used across multiple applications and platforms, but companies as well.
Streamlink started from the inaugural fork of Livestreamer on September 17th, 2016.
Since then, We've hit multiple milestones:
Over 886 PRs
Hit 3,000 commits in Streamlink
Obtaining our first sponsors as well as backers of the project
The creation of our own logo (streamlink/streamlink#1123)
Thanks to everyone who has contributed to Streamlink (and our backers)! Without you, we wouldn't be where we are today.
Without further ado, here are the changes in release 1.0.0:
We have a new icon / logo for Streamlink! (streamlink/streamlink#2165)
Updated dependencies (streamlink/streamlink#2230)
A ton of plugin updates. Have a look at this search query for all the recent updates.
You can now provide a custom key URI to override HLS streams (streamlink/streamlink#2139). For example: --hls-segment-key-uri <URI>
User agents for API communication have been updated (streamlink/streamlink#2194)
Special synonyms have been added to sort "best" and "worst" streams (streamlink/streamlink#2127). For example: streamlink --stream-sorting-excludes '>=480p' URL best,best-unfiltered
Process output will no longer show if tty is unavailable (streamlink/streamlink#2090)
We've removed BountySource in favour of our OpenCollective page. If you have any features you'd like to request, please open up an issue with the request and possibly consider backing us!
Improved terminal progress display for wide characters (streamlink/streamlink#2032)
Fixed a bug with dynamic playlists on playback (streamlink/streamlink#2096)
Fixed makeinstaller.sh (streamlink/streamlink#2098)
Old Livestreamer deprecations and API references were removed (streamlink/streamlink#1987)
Dependencies have been updated for Python (streamlink/streamlink#1975)
Newer and more common User-Agents are now used (streamlink/streamlink#1974)
DASH stream bitrates now round-up to the nearest 10, 100, 1000, etc. (streamlink/streamlink#1995)
Updated documentation on issue templates (streamlink/streamlink#1996)
URL have been added for better processing of HTML tags (streamlink/streamlink#1675)
Fixed sort and prog issue (streamlink/streamlink#1964)
Reformatted issue templates (streamlink/streamlink#1966)
Fixed crashing bug with player-continuous-http option (streamlink/streamlink#2234)
Make sure all dev dependencies (streamlink/streamlink#2235)
-r parameter has been replaced for --rtmp-rtmpdump (streamlink/streamlink#2152)
Breaking changes:
A large number of unmaintained or NSFW plugins have been removed. You can find the PR that implemented that change here: streamlink/streamlink#2003 . See our CONTRIBUTING.md documentation for plugin policy.
mkbloke
pushed a commit
to mkbloke/streamlink
that referenced
this pull request
Aug 18, 2020
* Reword+reformat issue templates for consistency * Change issue templates according to suggestions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1961
Further discussion is welcome.