Create CONTRIBUTING.md

This commit is contained in:
Jerko Steiner 2016-04-03 13:48:34 -04:00
parent 70304662f0
commit 34ffc8510a

50
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,50 @@
# Contributing
Thank you for your interest to contribute to Peer Calls. By participating in
this project, you agree to abide by the [code of conduct].
[code of conduct]: CODE_OF_CONDUCT.md
Everyone is expected to follow the code of conduct anywhere in the project
codebases, issue trackers and chatrooms.
## Notice
Before contributing, check the issue tracker and see if there is already an
issue about something you're trying to implement. Check if somebody else is
already assigned to the issue. It is recommended to *ask* or create an issue
before implementing changes because this way you'll have a lower chance that
your pull request will be rejected.
## Contributing Code
- Fork the repo
- Install dependencies
```
npm install
```
- Make sure the tests pass:
```
npm test
```
- Make your change, with new passing tests. Follow the [style guide][style].
[style]: STYLE_GUIDE.md
- Push to your fork. Write a [good commit message][commit]. Submit a pull request.
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
Others will give constructive feedback. This is a time for discussion and
improvements, and making the necessary changes will be required before we can
merge the contribution.
## License
As the project uses the MIT license, you agree that any code you submit to the
project will also be licensed under the same license.