Skip to content

Commit 70a9a4a

Browse files
committed
Readme about contributing to the project
1 parent 27e2c01 commit 70a9a4a

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contributing to the development of node-zookeeper
2+
3+
Fork this repo, write code and send a pull request. Easy!
4+
5+
### Guidelines
6+
* Create a branch for the feature you are about to write.
7+
* If possible, isolate the changes in the branch to the feature only. Merges will be easier if general refactorings, that are not specific to the feature, are made in separate branches.
8+
* If possible, avoid general dependency updates in the feature branch.
9+
* If possible, send pull requests early. Don't wait too long, even if the feature is not completely done. The new code can very likely be merged without causing any problems (if the code changes are not of type breaking features). Think of it as "silent releases".
10+
* If you think it is relevant and add value: write unit test(s). Use the`tape` unit test library. They could also be valuable as description of features.

0 commit comments

Comments
 (0)