| 1 | # CONTRIBUTING
|
| 2 |
|
| 3 | We welcome contributions from everyone!
|
| 4 |
|
| 5 | ## Code of Conduct
|
| 6 |
|
| 7 | Please read our [Contributor Covenant Code of Conduct](CONDUCT.md) before continuing.
|
| 8 |
|
| 9 | ## Getting Started
|
| 10 |
|
| 11 | Make sure you have Node.js 8 or higher and npm installed.
|
| 12 |
|
| 13 | 1. Fork this repository and clone your fork
|
| 14 | 1. Install dependencies: `npm install`
|
| 15 | 1. Run a development server: `npm start`
|
| 16 |
|
| 17 | ### Making Changes
|
| 18 |
|
| 19 | Refer to the [video.js plugin conventions][conventions] for more detail on best practices and tooling for this plugin.
|
| 20 |
|
| 21 | When you've made your changes, push your commit(s) to your fork and issue a pull request against the original repository.
|
| 22 |
|
| 23 | ### Running Tests
|
| 24 |
|
| 25 | 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][karma].
|
| 26 |
|
| 27 | - In all available and supported browsers: `npm test`
|
| 28 | - In a specific browser: `npm run test:chrome`, `npm run test:firefox`, etc.
|
| 29 | - While development server is running (`npm start`), navigate to [`http://localhost:9999/test/`][local]
|
| 30 |
|
| 31 |
|
| 32 | [karma]: http://karma-runner.github.io/
|
| 33 | [local]: http://localhost:9999/test/
|
| 34 | [conventions]: https://github.com/videojs/generator-videojs-plugin/blob/master/docs/conventions.md
|