Skip to content

docs: update plugin guidelines #3244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

bastimeyer
Copy link
Member

The last revision of the plugin request/submission guidelines was made two years ago in #1838.
Lately we've seen a few requests and PRs for radio stations, which we don't want to merge. This should be included in the list of plugin restrictions.

I've also added a generic pull request template, since we don't have one. Nothing big, just a small reminder to read the guidelines, add a comment and run local checks if possible.

Copy link
Member

@gravyboat gravyboat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few changes for review and discussion, let me know what you think.

8. Sites which are unmaintained

9. Sites which don't provide any video streaming content, eg. radio stations

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's worth adding a few additional lines such as:

10. Sites which create a live stream of previously recorded content, such as TV shows, movies, news broadcasts, etc.

11. Sites which have no way to determine viewership numbers

12. Sites which are static cameras of a physical location

13. Sites which are in beta or undergoing heavy amounts of development and may change rapidly

This should cover us for more plugins and keep people from wasting their time and ours.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with all of those, but I feel like a list of 13 points makes it a bit too much IMO.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, your changes are good.

@bastimeyer bastimeyer force-pushed the docs/update-plugin-guidelines branch from da679d2 to 35739cf Compare October 12, 2020 05:41
@bastimeyer bastimeyer changed the title docs: update plugin guidelines and add pull request template docs: update plugin guidelines Oct 12, 2020
@bastimeyer
Copy link
Member Author

  • merged "mostly hosting VODs" with "live stream of previously recorded content"
  • merged "unmaintained" with "in beta or are undergoing heavy amounts of development and may change rapidly"
  • added "no way to determine viewership numbers"
  • added "static cameras of a physical location"
  • re-ordered the list a bit

Is that okay?

@gravyboat
Copy link
Member

Yep! Merging.

@gravyboat gravyboat merged commit 12f6e47 into streamlink:master Oct 12, 2020
@bastimeyer bastimeyer deleted the docs/update-plugin-guidelines branch October 13, 2020 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants