From 34ffc8510a22ccd688d1a34734773e092f7ed797 Mon Sep 17 00:00:00 2001 From: Jerko Steiner Date: Sun, 3 Apr 2016 13:48:34 -0400 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d4c54b0 --- /dev/null +++ b/CONTRIBUTING.md @@ -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.