adding contributor guidelines

This commit is contained in:
Blake Eggleston
2013-06-03 10:11:38 -07:00
parent 55f16442e3
commit 24eba1bbc0

12
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,12 @@
### Contributing code to cqlengine
Before submitting a pull request, please make sure that it follows these guidelines:
* Limit yourself to one feature or bug fix per pull request.
* Include unittests that thoroughly test the feature/bug fix
* Write clear, descriptive commit messages.
* Many granular commits are preferred over large monolithic commits
* If you're adding or modifying features, please update the documentation
If you're working on a big ticket item, please check in on [cqlengine-users](https://groups.google.com/forum/?fromgroups#!forum/cqlengine-users).
We'd hate to have to steer you in a different direction after you've already put in a lot of hard work.