From 1fa18ab656af1bfe5805cecdd82db9f0327c8879 Mon Sep 17 00:00:00 2001 From: Ping Xie Date: Thu, 28 Mar 2024 17:39:41 -0700 Subject: [PATCH] Fix remaining names in CONTRIBUTING.md Signed-off-by: Ping Xie --- .gitignore | 1 + CONTRIBUTING.md | 35 ++++++++++++++++++++++++----------- 2 files changed, 25 insertions(+), 11 deletions(-) diff --git a/.gitignore b/.gitignore index c9ea5d33c4..fa53b69d67 100644 --- a/.gitignore +++ b/.gitignore @@ -41,3 +41,4 @@ Makefile.dep .ccls-cache/* compile_commands.json redis.code-workspace +.cache diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 548204eb83..ad257664c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,14 @@ -Note: by contributing code to the Redis project in any form, including sending +Note: by contributing code to the Valkey 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 Redis license that you can find in the COPYING file included in the Redis +of the Valkey license that you can find in the COPYING file included in the Valkey source distribution. -# IMPORTANT: HOW TO USE REDIS GITHUB ISSUES +# IMPORTANT: HOW TO USE VALKEY GITHUB ISSUES GitHub issues SHOULD ONLY BE USED to report bugs and for DETAILED feature requests. Everything else should be asked on Discord: - + https://discord.gg/zbcPa5umUB PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected @@ -27,9 +27,14 @@ If you are reporting a security bug or vulnerability, see SECURITY.md. ## Developer Certificate of Origin -We respect the intellectual property rights of others and we want to make sure all incoming contributions are correctly attributed and licensed. A Developer Certificate of Origin (DCO) is a lightweight mechanism to do that. The DCO is a declaration attached to every commit. In the commit message of the contribution, the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/). +We respect the intellectual property rights of others and we want to make sure +all incoming contributions are correctly attributed and licensed. A Developer +Certificate of Origin (DCO) is a lightweight mechanism to do that. The DCO is +a declaration attached to every commit. In the commit message of the contribution, +the developer simply adds a `Signed-off-by` statement and thereby agrees to the DCO, +which you can find below or at [DeveloperCertificate.org](http://developercertificate.org/). -``` +```text Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: @@ -56,14 +61,21 @@ By making a contribution to this project, I certify that: sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. - ``` +``` -We require that every contribution to Valkey to be signed with a DCO. We require the usage of known identity (such as a real or preferred name). We do not accept anonymous contributors nor those utilizing pseudonyms. A DCO signed commit will contain a line like: +We require that every contribution to Valkey to be signed with a DCO. We require the +usage of known identity (such as a real or preferred name). We do not accept anonymous +contributors nor those utilizing pseudonyms. A DCO signed commit will contain a line like: -``` + +```text Signed-off-by: Jane Smith ``` -You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `git commit` with `-s` or `--signoff` to add the `Signed-off-by` line to the end of the commit message. We also require revert commits to include a DCO. + +You may type this line on your own when writing your commit messages. However, if your +user.name and user.email are set in your git configs, you can use `git commit` with `-s` +or `--signoff` to add the `Signed-off-by` line to the end of the commit message. We also +require revert commits to include a DCO. # How to provide a patch for a new feature @@ -74,7 +86,8 @@ 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 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: +2. If in step 1 you get an acknowledgment from the project leaders, use the following +procedure to submit a patch: 1. Fork Valkey on GitHub ( https://docs.github.com/en/github/getting-started-with-github/fork-a-repo ) 1. Create a topic branch (git checkout -b my_branch) 1. Make the needed changes and commit with a DCO. (git commit -s)