Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 2.82 KB
Raw

Contributing

If you are interested in making a contribution there are a few ways you could help out the project.

Filing issues

GitHub Issues are used for all discussions around the codebase, including bugs and features.

Reporting a Bug

Good bug reports can be very helpful. A bug is a demonstrable problem with the code.

Guidelines for bug reports:

  1. Please use the GitHub issue search — check if the issue has already been reported.
  2. Check if the issue has already been fixed — try to reproduce it using the uncompressed code from latest master branch in the repository.
  3. Create a small demo with the live example (reduced test case). You can possibly use this codepen template as a starting point -- don't forget to update it to the fluid-player version you use.

A good bug report should be as detailed as possible, so that others won't have to follow up for the essential details.

File a bug report

Requesting a Feature

  1. Search the issues for any previous requests for the same feature, and give a thumbs up or +1 on existing requests.
  2. If no previous requests exist, create a new issue. Please be as clear as possible about why the feature is needed and the intended use case.

Request a feature

Contributing code

If you plan to propose code changes it is required you create an issue issue with a brief proposal (as described in Requesting a Feature) and discuss it with us first.

This is necessary to avoid more than one contributor working on the same feature/change and to avoid someone spending time on feature/change that would not be merged for some reason.

For smaller contributions just use this workflow:

  • Create an issue describing the changes.
  • Await confirmation from contributors.
  • Fork the project.
  • Create a branch for your feature or bug fix.
  • Add code changes.
  • All new features or changes to the player settings or interface have to be documented in the docs repo, so that they are displayed on https://docs.fluidplayer.com. If you have made changes like this, please fork fluid-player-docs as well and create a branch with the same name as the feature branch, adding necessary changes to documentation.
  • Send a pull request (both for fluid-player and fluid-player-docs)

After one of the contributors has checked and approved the changes, they will be merged into master branch and will be included in the next release tag.