Update CONTRIBUTING.md
This commit is contained in:
parent
34ffc8510a
commit
3d4c46a32f
@ -13,32 +13,27 @@ codebases, issue trackers and chatrooms.
|
||||
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.
|
||||
before implementing changes - 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].
|
||||
1. Fork the repo
|
||||
2. Install dependencies: `npm install`
|
||||
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].
|
||||
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].
|
||||
- [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.
|
||||
|
||||
[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
|
||||
[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
|
||||
improvements, and making the necessary changes will be required before we can
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user