Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.34 KB
Raw

CONTRIBUTING

We welcome contributions from everyone!

Getting Started

Make sure you have NodeJS 4.0 or higher and npm installed.

  1. Fork this repository and clone your fork
  2. Install dependencies: npm install
  3. Run a development server: npm start

Making Changes

Refer to the video.js plugin conventions for more detail on best practices and tooling for video.js plugin authorship.

When you've made your changes, push your commit(s) to your fork and issue a pull request against the original repository.

Updating test expecations

You can regenerate the JS manifest files by running mpd-to-m3u8-json binary (or via the web page) but you'll need to update the pssh properties to be converted into a new Uint8Array.

Running Tests

Testing is a crucial part of any software project. For all but the most trivial changes (typos, etc) test cases are expected. Tests are run in actual browsers using Karma.

  • In all available and supported browsers: npm test
  • In a specific browser: npm run test:chrome, npm run test:firefox, etc.
  • While development server is running (npm start), navigate to http://localhost:9999/test/