Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.29 KB
Raw

Contributing to hls.js

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Did you write a patch that fixes a bug?

  • First, checkout the repository and install required dependencies
git clone https://github.com/dailymotion/hls.js.git
# setup dev environement
cd hls.js
npm install
# build dist/hls.js, watch file change for rebuild and launch demo page
npm run dev
# lint
npm run lint
# test
npm run test
  • Use EditorConfig or at least stay consistent to the file formats defined in the .editorconfig file.
  • Develop in a topic branch, not master
  • Don't commit the updated dist/hls.js file in your PR. We'll take care of generating an updated build right before releasing a new tagged version.

Thanks! ❤️ ❤️ ❤️