Skip to content

Commit

Permalink
Tweaked the readme file a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
supernomad committed Jul 3, 2015
1 parent 78bf397 commit 03cb2dc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Basic usage of chunkyjs is as simple as requiring the module and passing it into
chunkyjs is currently employing `node-cache` in order to store transfer specific metadata. This is great for development, however means that chunkyjs in its current state cannot be clustered. Support for clustered datastores is on the way.

### Contributing
We would love to have contributors, please just fork our master branch, and then make your changes. When you are done open up a PR.
We welcome contributions, feel free to fork us and make as many PR's as you would like.

A few guide lines:
- You should always rebase your branch on our latest master branch before making a PR.
- We want to maintain a status quo when it comes to the code in chunkyjs. So any PR should satisfy our codacy rules, and maintain the `A` ranking we currently have.
- Again to maintain the status quo all PR's should contain unit-tests that test the piece of additional funcationality or bug fix(s).
- Lastly all PR's should work as intended :)
- Again to maintain the status quo all PR's should contain unit-tests that test the additional funcationality and/or bug fix(s).
- Other than that happy coding

0 comments on commit 03cb2dc

Please sign in to comment.