plyr/CONTRIBUTING.md

Contributing

We welcome bug reports, feature requests and pull requests. If you want to help us out, please follow these guidelines, in order to avoid redundant work.

Reporting issues

Our GitHub issue tracker is for bug reports and feature requests. Don't create support issues here. Use Stack Overflow or our Slack for that.

Please verify that your issue hasn't already been answered by our FAQ (https://github.com/sampotts/plyr/wiki/FAQ), or that there isn't already an open issue for it.

When applicable, check that your problem doesn't happen without Plyr (see FAQ#1).

Verify that you are following the documentation, are using the latest version of Plyr, and aren't getting any errors in your own code, causing the issues.

Describe the issue as detailed as possible, answering these questions:

• Does it happen only with specific options and/or specific browsers?
• Does is happen only with HTML5 video, audio, youtube, vimeo or a specific library?
• Does the issue happen on our demo? If not, please recreate it with a minimal example online. You can use our Codepen templates to get started:
  • HTML5 video
  • HTML5 audio
  • YouTube
  • Vimeo
  • Dash.js integration
  • Hls.js integration
  • Shaka Player integration

Requesting features and improvements

If you are missing something in Plyr, you can create a GitHub issue for this as well. Since we prioritize fixing bugs first, and may have a lot of other suggestions and architectural changes to work on as well, these may not be at the top of our list. If it's important or urgent to you, you may want to first ensure it's something we want to have in Plyr, and then contribute it as a pull request.

Contributing features and documentation

• Fork Plyr, and create a new branch in your fork, based on the develop branch

• To test locally, you can use the demo. First make sure you have installed the dependencies with npm install or yarn. Run gulp to build while you are working, and run a local server from the repository root directory. If you have Python installed, this command should work: python -m SimpleHTTPServer 8080. Then go to http://localhost:8080/demo/

• Develop and test your modifications.

• Preferably commit your changes as independent logical chunks, with meaningful messages. Make sure you do not commit unnecessary files or changes, such as logging or breakpoints you added for testing, and the build output.

• If your modifications changes the documented behavior or add new features, document these changes in readme.md.

• When finished, push the changes to your GitHub repository and send a pull request to develop. Describe what your PR does.

• If the Travis build fails, or if you get a code review with change requests, you can fix these by pushing new or rebased commits to the branch.