From 16f515ddf693c18d5b5916b3f85ffb0cca551e3c Mon Sep 17 00:00:00 2001 From: Pete Cook Date: Tue, 19 Apr 2016 10:53:58 +0100 Subject: [PATCH] Add contribution guidelines --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ README.md | 19 +++---------------- 2 files changed, 26 insertions(+), 16 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4b1352a7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing to ReactPlayer + +Thanks for contributing to ReactPlayer! + +## `dist` files + +There is **no need** to build or commit files in `dist` after making changes. The `dist` files are only there for [bower](http://bower.io) 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 commmited when new versions are released, so your changes will be included then. + +## Linting + +This project uses [standard](https://github.com/feross/standard) code style. Be sure to lint the code after making changes and fix any issues that come up. + +```bash +npm run lint +``` + +## Testing + +This project uses [karma](https://karma-runner.github.io) with [mocha](https://github.com/mochajs/mocha) and [chai](https://github.com/chaijs/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. + +```bash +npm test +``` diff --git a/README.md b/README.md index 484e341c..e292efe9 100644 --- a/README.md +++ b/README.md @@ -123,24 +123,11 @@ To seek to a certain part of the media, there is a `seekTo(fraction)` instance m * Vimeo videos use the [Vimeo Player API]() * MP4/WEBM/OGG/MP3/WAV files use the [HTML media object]() -### Linting +### Contributing -This project uses [standard](https://github.com/feross/standard) code style. - -```bash -npm run lint -``` - -### Testing - -This project uses [mocha](https://github.com/mochajs/mocha) with [chai](https://github.com/chaijs/chai) assertions for unit testing. - -```bash -npm run test -``` +See the [contribution guidelines](https://github.com/CookPete/react-player/blob/master/CONTRIBUTING.md) before creating a pull request. ### Thanks +* Anyone who has [contributed](https://github.com/CookPete/react-player/graphs/contributors) * [gaearon](https://github.com/gaearon) for his [react-transform-boilerplate](https://github.com/gaearon/react-transform-boilerplate), which this repo is roughly based on. -* [Simon Smith](http://simonsmith.io) for his [intro to react testing with shallow rendering](http://simonsmith.io/unit-testing-react-components-without-a-dom/) -* [Fauntleroy](https://github.com/Fauntleroy) for his contributions