rondomoon/peer-calls
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Jerko Steiner 2016-04-03 13:56:46 -04:00
parent 34ffc8510a
commit 3d4c46a32f
1 changed files with 15 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
CONTRIBUTING.md
View File

@ -13,32 +13,27 @@ codebases, issue trackers and chatrooms.
Before contributing, check the issue tracker and see if there is already an 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 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 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 before implementing changes - this way you'll have a lower chance that your
your pull request will be rejected. pull request will be rejected.
## Contributing Code ## Contributing Code
- Fork the repo 1. Fork the repo
2. Install dependencies: `npm install`
- Install dependencies 3. Make sure the tests pass: `npm test`
4. Make your change on a new feature branch, with new passing tests. Follow
``` the [style guide][style].
npm install 5. Push to your fork.
``` 6. Make sure to rebase to master and squash commits to a single commit.
7. Write a [good commit message][commit].
- Make sure the tests pass: - [Reference][reference] the issue in the commit message.
- Remember that you can also [close][close] the issue with this message.
``` 8. Submit a pull request.
npm test
```
- Make your change, with new passing tests. Follow the [style guide][style].
[style]: STYLE_GUIDE.md [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 [commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[reference]: https://help.github.com/articles/autolinked-references-and-urls/#issues-and-pull-requests
[close]: https://help.github.com/articles/closing-issues-via-commit-messages/
Others will give constructive feedback. This is a time for discussion and Others will give constructive feedback. This is a time for discussion and
improvements, and making the necessary changes will be required before we can improvements, and making the necessary changes will be required before we can