xref: /f-stack/app/redis-5.0.5/CONTRIBUTING (revision 572c4311)
1*572c4311SfengbojiangNote: by contributing code to the Redis project in any form, including sending
2*572c4311Sfengbojianga pull request via Github, a code fragment or patch via private email or
3*572c4311Sfengbojiangpublic discussion groups, you agree to release your code under the terms
4*572c4311Sfengbojiangof the BSD license that you can find in the COPYING file included in the Redis
5*572c4311Sfengbojiangsource distribution. You will include BSD license in the COPYING file within
6*572c4311Sfengbojiangeach source file that you contribute.
7*572c4311Sfengbojiang
8*572c4311Sfengbojiang# IMPORTANT: HOW TO USE REDIS GITHUB ISSUES
9*572c4311Sfengbojiang
10*572c4311Sfengbojiang* Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature
11*572c4311Sfengbojiang  requests. Everything else belongs to the Redis Google Group:
12*572c4311Sfengbojiang
13*572c4311Sfengbojiang      https://groups.google.com/forum/m/#!forum/Redis-db
14*572c4311Sfengbojiang
15*572c4311Sfengbojiang  PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected
16*572c4311Sfengbojiang  bugs in the Github issues system. We'll be very happy to help you and provide
17*572c4311Sfengbojiang  all the support in the mailing list.
18*572c4311Sfengbojiang
19*572c4311Sfengbojiang  There is also an active community of Redis users at Stack Overflow:
20*572c4311Sfengbojiang
21*572c4311Sfengbojiang      http://stackoverflow.com/questions/tagged/redis
22*572c4311Sfengbojiang
23*572c4311Sfengbojiang# How to provide a patch for a new feature
24*572c4311Sfengbojiang
25*572c4311Sfengbojiang1. If it is a major feature or a semantical change, please don't start coding
26*572c4311Sfengbojiangstraight away: if your feature is not a conceptual fit you'll lose a lot of
27*572c4311Sfengbojiangtime writing the code without any reason. Start by posting in the mailing list
28*572c4311Sfengbojiangand creating an issue at Github with the description of, exactly, what you want
29*572c4311Sfengbojiangto accomplish and why. Use cases are important for features to be accepted.
30*572c4311SfengbojiangHere you'll see if there is consensus about your idea.
31*572c4311Sfengbojiang
32*572c4311Sfengbojiang2. If in step 1 you get an acknowledgment from the project leaders, use the
33*572c4311Sfengbojiang   following procedure to submit a patch:
34*572c4311Sfengbojiang
35*572c4311Sfengbojiang    a. Fork Redis on github ( http://help.github.com/fork-a-repo/ )
36*572c4311Sfengbojiang    b. Create a topic branch (git checkout -b my_branch)
37*572c4311Sfengbojiang    c. Push to your branch (git push origin my_branch)
38*572c4311Sfengbojiang    d. Initiate a pull request on github ( https://help.github.com/articles/creating-a-pull-request/ )
39*572c4311Sfengbojiang    e. Done :)
40*572c4311Sfengbojiang
41*572c4311Sfengbojiang3. Keep in mind that we are very overloaded, so issues and PRs sometimes wait
42*572c4311Sfengbojiangfor a *very* long time. However this is not lack of interest, as the project
43*572c4311Sfengbojianggets more and more users, we find ourselves in a constant need to prioritize
44*572c4311Sfengbojiangcertain issues/PRs over others. If you think your issue/PR is very important
45*572c4311Sfengbojiangtry to popularize it, have other users commenting and sharing their point of
46*572c4311Sfengbojiangview and so forth. This helps.
47*572c4311Sfengbojiang
48*572c4311Sfengbojiang4. For minor fixes just open a pull request on Github.
49*572c4311Sfengbojiang
50*572c4311SfengbojiangThanks!
51