X-Git-Url: https://git.saurik.com/redis.git/blobdiff_plain/7c748c061ecb630f52d0041c5d2497783aac5c06..886c9ecb7c0a68299bbc9b09020d14b3293e2f5a:/CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING index 3afa77fc..17078749 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,13 +1,33 @@ -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. +Note: by contributing code to the Redis project in any form, including sending +a pull request via Github, a code fragment or patch via private email or +public discussion groups, you agree to release your code under the terms +of the BSD license that you can find in the COPYING file included in the Redis +source distribution. -2. Drop a message to the Redis Google Group with a proposal of semantics/API. +# IMPORTANT: HOW TO USE REDIS GITHUB ISSUES -3. If steps 1 and 2 are ok, use the following procedure to submit a patch: +* Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature + requests. Everything else belongs to the Redis Google Group. - a. Fork Redis on github + 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. + + 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) - 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!