Skip to content
This repository was archived by the owner on Feb 28, 2019. It is now read-only.

Commit 9c9f1da

Browse files
committed
Add basic contributing doco
1 parent 68eedff commit 9c9f1da

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# How to Contribute
2+
3+
Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
4+
5+
* Fork it
6+
* Create your feature branch (`git checkout -b my-new-feature`)
7+
* Commit your changes (`git commit -am 'Add some feature'`)
8+
* Push to the branch (`git push origin my-new-feature`)
9+
* Create new Pull Request
10+
11+
Pester us if we don't get your Pull Requests merged in a timely fashion. :)
12+
13+
## How to speed the merging of pull requests
14+
15+
* Describe your changes in the CHANGELOG.
16+
* Give yourself some credit in the appropriate place (usually the CHANGELOG).
17+
* Make commits of logical units.
18+
* Ensure your commit messages help others understand what you are doing and why.
19+
* Check for unnecessary whitespace with `git diff --check` before committing.
20+
* Maintain the same code style.
21+
* Maintain the same level of test coverage or improve it.
22+
23+
## Additional Resources
24+
25+
* [General GitHub documentation](http://help.github.com/)
26+
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

0 commit comments

Comments
 (0)