Skip to content

Latest commit

 

History

History
34 lines (20 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

34 lines (20 loc) · 1.22 KB
Raw

CONTRIBUTING

We welcome contributions from everyone!

Code of Conduct

Please read our Contributor Covenant Code of Conduct before continuing.

Getting Started

Make sure you have Node.js 8 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 this plugin.

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

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/