From 518983835006dc670cc8dd210293fe608fb909a9 Mon Sep 17 00:00:00 2001 From: Lior Kogan Date: Wed, 3 Jan 2024 17:21:19 +0200 Subject: [PATCH] Update CONTRIBUTING.md (#12907) - Referring to Redis Discord channel instead of the mailing list. - Referring to the licensing instead of repeating it. --- CONTRIBUTING.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56b71834d..359020e07 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,19 @@ 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 +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. You will include BSD license in the COPYING file within -each source file that you contribute. +of the Redis license that you can find in the COPYING file included in the Redis +source distribution. # IMPORTANT: HOW TO USE REDIS GITHUB ISSUES -Github issues SHOULD ONLY BE USED to report bugs, and for DETAILED feature -requests. Everything else belongs to the Redis Google Group: +GitHub issues SHOULD ONLY BE USED to report bugs and for DETAILED feature +requests. Everything else should be asked on Discord: - https://groups.google.com/forum/m/#!forum/Redis-db + https://discord.com/invite/redis 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 mailing list. +bugs in the GitHub issues system. We'll be delighted to help you and provide +all the support on Discord. There is also an active community of Redis users at Stack Overflow: @@ -33,24 +32,24 @@ straight away: if your feature is not a conceptual fit you'll lose a lot of time writing the code without any reason. Start by posting in the mailing list and creating an issue at Github with the description of, exactly, what you want to accomplish and why. Use cases are important for features to be accepted. -Here you'll see if there is consensus about your idea. +Here you can see if there is consensus about your idea. 2. If in step 1 you get an acknowledgment from the project leaders, use the following procedure to submit a patch: - a. Fork Redis on github ( https://docs.github.com/en/github/getting-started-with-github/fork-a-repo ) + a. Fork Redis on GitHub ( https://docs.github.com/en/github/getting-started-with-github/fork-a-repo ) b. Create a topic branch (git checkout -b my_branch) c. Push to your branch (git push origin my_branch) - d. Initiate a pull request on github ( https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request ) + d. Initiate a pull request on GitHub ( https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request ) e. Done :) 3. Keep in mind that we are very overloaded, so issues and PRs sometimes wait -for a *very* long time. However this is not lack of interest, as the project +for a *very* long time. However this is not a lack of interest, as the project gets more and more users, we find ourselves in a constant need to prioritize certain issues/PRs over others. If you think your issue/PR is very important try to popularize it, have other users commenting and sharing their point of -view and so forth. This helps. +view, and so forth. This helps. -4. For minor fixes just open a pull request on Github. +4. For minor fixes - open a pull request on GitHub. Thanks!