Skip to content

Commit 16f515d

Browse files
committed
Add contribution guidelines
1 parent e4950a0 commit 16f515d

2 files changed

Lines changed: 26 additions & 16 deletions

File tree

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to ReactPlayer
2+
3+
Thanks for contributing to ReactPlayer!
4+
5+
## `dist` files
6+
7+
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.
8+
9+
## Linting
10+
11+
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.
12+
13+
```bash
14+
npm run lint
15+
```
16+
17+
## Testing
18+
19+
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.
20+
21+
```bash
22+
npm test
23+
```

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -123,24 +123,11 @@ To seek to a certain part of the media, there is a `seekTo(fraction)` instance m
123123
* Vimeo videos use the [Vimeo Player API]()
124124
* MP4/WEBM/OGG/MP3/WAV files use the [HTML media object]()
125125

126-
### Linting
126+
### Contributing
127127

128-
This project uses [standard](https://github.com/feross/standard) code style.
129-
130-
```bash
131-
npm run lint
132-
```
133-
134-
### Testing
135-
136-
This project uses [mocha](https://github.com/mochajs/mocha) with [chai](https://github.com/chaijs/chai) assertions for unit testing.
137-
138-
```bash
139-
npm run test
140-
```
128+
See the [contribution guidelines](https://github.com/CookPete/react-player/blob/master/CONTRIBUTING.md) before creating a pull request.
141129

142130
### Thanks
143131

132+
* Anyone who has [contributed](https://github.com/CookPete/react-player/graphs/contributors)
144133
* [gaearon](https://github.com/gaearon) for his [react-transform-boilerplate](https://github.com/gaearon/react-transform-boilerplate), which this repo is roughly based on.
145-
* [Simon Smith](http://simonsmith.io) for his [intro to react testing with shallow rendering](http://simonsmith.io/unit-testing-react-components-without-a-dom/)
146-
* [Fauntleroy](https://github.com/Fauntleroy) for his contributions

0 commit comments

Comments
 (0)