gvsafronov/futriix
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Fix remaining names in CONTRIBUTING.md (#70)

Browse Source 
Signed-off-by: Ping Xie <pingxie@google.com>
This commit is contained in:
Ping Xie 2024-03-29 10:38:13 -07:00 committed by GitHub
parent 9be3a1d5ab
commit 1950acd1e2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -41,3 +41,4 @@ Makefile.dep
.ccls-cache/* .ccls-cache/*
compile_commands.json compile_commands.json
redis.code-workspace redis.code-workspace
.cache

37
CONTRIBUTING.md
View File

@ -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 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 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. 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 GitHub issues SHOULD ONLY BE USED to report bugs and for DETAILED feature
requests. Everything else should be asked on Discord: requests. Everything else should be asked on Discord:
https://discord.gg/zbcPa5umUB https://discord.gg/zbcPa5umUB
PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected 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 ## 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 Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that: 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 sign-off) is maintained indefinitely and may be redistributed
consistent with this project or the open source license(s) consistent with this project or the open source license(s)
involved. 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 <jane.smith@email.com> Signed-off-by: Jane Smith <jane.smith@email.com>
``` ```
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 # 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. to accomplish and why. Use cases are important for features to be accepted.
Here you can 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: 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. 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. Create a topic branch (git checkout -b my_branch)
1. Make the needed changes and commit with a DCO. (git commit -s) 1. Make the needed changes and commit with a DCO. (git commit -s)