CONTRIBUTING file updated.

[redis.git] / CONTRIBUTING

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 3afa77fc3be7cca3defb6e586a0ab6f3906a3f60..1ecd13945c48492f45a9bb91c6c89b2a506831f1 100644 (file)
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -1,13 +1,27 @@
-1. Enter irc.freenode.org #redis and start talking with 'antirez' and/or 'pietern' to check if there is interest for such a feature and to understand the probability of it being merged. We'll try hard to keep Redis simple... so you'll likely encounter high resistance.
+# IMPORTANT: HOW TO USE REDIS GITHUB ISSUES

 
 

-2. Drop a message to the Redis Google Group with a proposal of semantics/API.
+* Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature
+  requests. Everything else belongs to the Redis Google Group.

 
 

-3. If steps 1 and 2 are ok, use the following procedure to submit a patch:
+  PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected
+  bugs in the Github issues system. We'll be very happy to help you and provide
+  all the support in the Redis Google Group.

 
 

-    a. Fork Redis on github
+  Redis Google Group address:
+  
+      https://groups.google.com/forum/?fromgroups#!forum/redis-db
+
+# How to provide a patch for a new feature
+
+1. Drop a message to the Redis Google Group with a proposal of semantics/API.
+
+2. If in steps 1 you get an acknowledge from the project leaders, use the
+   following procedure to submit a patch:
+
+    a. Fork Redis on github ( http://help.github.com/fork-a-repo/ )

     b. Create a topic branch (git checkout -b my_branch)
     c. Push to your branch (git push origin my_branch)
     b. Create a topic branch (git checkout -b my_branch)
     c. Push to your branch (git push origin my_branch)

-    d. Create an issue in the Redis google code site with a link to your patch
+    d. Initiate a pull request on github ( http://help.github.com/send-pull-requests/ )

     e. Done :)
 
 Thanks!
     e. Done :)
 
 Thanks!