Permalink
Browse files

Added CONTRIBUTING.md

Change-Id: I483aae48975bcb8461b534470d12a2d4508ca135
Reviewed-on: http://review.couchbase.org/22400
Reviewed-by: Matt Ingenthron <matt@couchbase.com>
Reviewed-by: Sergey Avseyev <sergey.avseyev@gmail.com>
Tested-by: Sergey Avseyev <sergey.avseyev@gmail.com>
  • Loading branch information...
1 parent 40a3bae commit 72b94a95d3cd5a5a5daf0bb899ce0865782a72ed @trondn trondn committed with avsej Nov 9, 2012
Showing with 47 additions and 0 deletions.
  1. +46 −0 CONTRIBUTING.md
  2. +1 −0 Makefile.am
View
@@ -0,0 +1,46 @@
+We've decided to use "gerrit" for our code review system, making it
+easier for all of us to contribute with code and comments. You'll
+find our gerrit server running at:
+
+http://review.couchbase.org/
+
+The first thing you would do would be to "sign up" for an account
+there, before you jump to:
+
+http://review.couchbase.org/#/q/status:open+project:libcouchbase,n,z
+
+With that in place you should probably jump on IRC and join the #libcouchbase
+chatroom to hang out with the rest of us :-)
+
+If you haven't done so already you should download repo from
+http://code.google.com/p/git-repo/downloads/list and put it in your
+path.
+
+All you should need to set up your development environment should be:
+
+ trond@ok ~> mkdir devel
+ trond@ok ~> cd devel
+ trond@ok ~/devel> repo init -u git://github.com/trondn/manifests.git -m libcouchbase.xml
+ trond@ok ~/devel> repo sync
+ trond@ok ~/devel> repo start my-branch-name --all
+ trond@ok ~/devel> cd lcb
+
+When you're done making your changes to libcouchbase (check the
+"hacking" section in README.markdown), commit them to the repository
+by using git commit, and upload them to gerrit with the following
+command:
+
+ trond@ok ~/devel> repo upload
+
+You might experience a problem trying to upload the patches if you've
+selected a different login name review.couchbase.org than your login
+name. Don't worry, all you need to do is to add the following to your
+~/.gitconfig file:
+
+ [review "review.couchbase.org"]
+ username = trond
+
+I normally don't go looking for stuff in gerrit, so you should add at
+least me (trond.norbye@gmail.com) or Sergey Avseyev
+<sergey.avseyev@gmail.com> as a reviewer for your patch (and we'll
+know who else to add and add them for you).
View
@@ -369,6 +369,7 @@ uninstall-local:
endif
EXTRA_DIST = \
+ CONTRIBUTING.md \
LICENSE \
NMakefile \
README.markdown \

0 comments on commit 72b94a9

Please sign in to comment.