CONTRIBUTING 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. Note: by contributing code to the Redis project in any form, including sending
  2. a pull request via Github, a code fragment or patch via private email or
  3. public discussion groups, you agree to release your code under the terms
  4. of the BSD license that you can find in the COPYING file included in the Redis
  5. source distribution. You will include BSD license in the COPYING file within
  6. each source file that you contribute.
  7. # IMPORTANT: HOW TO USE REDIS GITHUB ISSUES
  8. * Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature
  9. requests. Everything else belongs to the Redis Google Group.
  10. PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected
  11. bugs in the Github issues system. We'll be very happy to help you and provide
  12. all the support Reddit sub:
  13. http://reddit.com/r/redis
  14. There is also an active community of Redis users at Stack Overflow:
  15. http://stackoverflow.com/questions/tagged/redis
  16. # How to provide a patch for a new feature
  17. 1. If it is a major feature or a semantical change, please post it as a new submission in r/redis on Reddit at http://reddit.com/r/redis. Try to be passionate about why the feature is needed, make users upvote your proposal to gain traction and so forth. Read feedbacks about the community. But in this first step **please don't write code yet**.
  18. 2. If in step 1 you get an acknowledge from the project leaders, use the
  19. following procedure to submit a patch:
  20. a. Fork Redis on github ( http://help.github.com/fork-a-repo/ )
  21. b. Create a topic branch (git checkout -b my_branch)
  22. c. Push to your branch (git push origin my_branch)
  23. d. Initiate a pull request on github ( http://help.github.com/send-pull-requests/ )
  24. e. Done :)
  25. For minor fixes just open a pull request on Github.
  26. Thanks!