Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.14 KB
Raw

Contributing to ReactPlayer

Thanks for contributing to ReactPlayer!

Running the demo locally is relatively easy:

git clone https://github.com/CookPete/react-player.git
cd react-player
npm install # or yarn
npm start
open http://localhost:3000

dist files

There is no need to build or commit files in dist after making changes. The dist files are only there for bower support, and there is very little point in polluting every commit or pull request with the changes. The dist files will be automatically built and committed when new versions are released, so your changes will be included then.

Linting

This project uses standard code style. Be sure to lint the code after making changes and fix any issues that come up.

npm run lint

Testing

This project uses karma with mocha and chai for testing in the browser. Be sure to test ReactPlayer after making changes and, if you’re feeling generous, add some tests of your own.

npm test