CONTRIBUTING.md: use the DCO

This commit is contained in:
Drew DeVault 2024-03-21 16:49:52 +01:00
parent 6e1f6f5288
commit 1c50b46ebf

View File

@ -1,55 +1,42 @@
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
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
source distribution.
Contributors to Redict are asked to agree to the [Developer Certificate of
Origin][0] when contributing code to the project:
# IMPORTANT: HOW TO USE REDIS GITHUB ISSUES
[0]: https://developercertificate.org/
GitHub issues SHOULD ONLY BE USED to report bugs and for DETAILED feature
requests. Everything else should be asked on Discord:
https://discord.com/invite/redis
```
Developer Certificate of Origin
Version 1.1
PLEASE DO NOT POST GENERAL QUESTIONS that are not about bugs or suspected
bugs in the GitHub issues system. We'll be delighted to help you and provide
all the support on Discord.
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
There is also an active community of Redis users at Stack Overflow:
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
https://stackoverflow.com/questions/tagged/redis
Issues and pull requests for documentation belong on the redis-doc repo:
Developer's Certificate of Origin 1.1
https://github.com/redis/redis-doc
By making a contribution to this project, I certify that:
If you are reporting a security bug or vulnerability, see SECURITY.md.
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
# How to provide a patch for a new feature
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
1. If it is a major feature or a semantical change, please don't start coding
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 can see if there is consensus about your idea.
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
2. If in step 1 you get an acknowledgment from the project leaders, use the
following procedure to submit a patch:
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
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 )
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 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.
4. For minor fixes - open a pull request on GitHub.
Thanks!
```