Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add DCO and fix badges in readme #7

Merged
merged 4 commits into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ ClusterPipeline
ClusterPubSub
ConnectionPool
CoreCommands
DCO
DeveloperCertificate
EVAL
EVALSHA
GraphCommands
Expand Down Expand Up @@ -75,6 +77,7 @@ boolean
booleans
bysource
charset
configs
del
dev
docstring
Expand Down
9 changes: 9 additions & 0 deletions .github/workflows/dco.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: DCO Check

on: [pull_request]

jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: tisonkun/actions-dco@v1.1
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,62 @@ If you don't know where to start, consider improving
documentation, bug triaging, and writing tutorials are all examples of
helpful contributions that mean less work for you.

## 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/).

```text
Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(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

(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

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(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.
```

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>
```

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.

If you're contributing code to the Valkey project in any other form, including
sending a code fragment or patch via private email or public discussion groups,
you need to ensure that the contribution is in accordance with the DCO.

## Your First Contribution

Unsure where to begin contributing? You can start by looking through
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

The Python interface to the Valkey key-value store.

[![CI](https://github.com/aiven-sal/valkey-py/workflows/CI/badge.svg?branch=master)](https://github.com/aiven-sal/valkey-py/actions?query=workflow%3ACI+branch%3Amaster)
[![docs](https://readthedocs.org/projects/valkey-py/badge/?version=stable&style=flat)](https://valkey-py.readthedocs.io/en/stable/)
[![CI](https://github.com/aiven-sal/valkey-py/workflows/CI/badge.svg?branch=main)](https://github.com/aiven-sal/valkey-py/actions?query=workflow%3ACI+branch%3Amain)
[![docs](https://readthedocs.org/projects/valkey-py/badge/?version=latest&style=flat)](https://valkey-py.readthedocs.io/en/latest/)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![pypi](https://badge.fury.io/py/valkey.svg)](https://pypi.org/project/valkey/)
[![pre-release](https://img.shields.io/github/v/release/aiven-sal/valkey-py?include_prereleases&label=latest-prerelease)](https://github.com/aiven-sal/valkey-py/releases)
[![codecov](https://codecov.io/gh/aiven-sal/valkey-py/branch/master/graph/badge.svg?token=yenl5fzxxr)](https://codecov.io/gh/aiven-sal/valkey-py)
[![codecov](https://codecov.io/gh/aiven-sal/valkey-py/branch/main/graph/badge.svg?token=yenl5fzxxr)](https://codecov.io/gh/aiven-sal/valkey-py)

[Installation](#installation) | [Usage](#usage) | [Advanced Topics](#advanced-topics) | [Contributing](https://github.com/aiven-sal/valkey-py/blob/master/CONTRIBUTING.md)
[Installation](#installation) | [Usage](#usage) | [Advanced Topics](#advanced-topics) | [Contributing](https://github.com/aiven-sal/valkey-py/blob/main/CONTRIBUTING.md)

---------------------------------------------

Expand Down Expand Up @@ -71,7 +71,7 @@ Alternatively, you might want to look at [Async connections](https://valkey-py.r

### Valkey Commands

There is built-in support for all of the [out-of-the-box Valkey commands](https://valkey.io/commands). They are exposed using the raw Redis command names (`HSET`, `HGETALL`, etc.) except where a word (i.e. del) is reserved by the language. The complete set of commands can be found [here](https://github.com/valkey/valkey-py/tree/master/redis/commands), or [the documentation](https://valkey-py.readthedocs.io/en/stable/commands.html).
There is built-in support for all of the [out-of-the-box Valkey commands](https://valkey.io/commands). They are exposed using the raw Redis command names (`HSET`, `HGETALL`, etc.) except where a word (i.e. del) is reserved by the language. The complete set of commands can be found [here](https://github.com/aiven-sal/valkey-py/tree/main/valkey/commands), or [the documentation](https://valkey-py.readthedocs.io/en/stable/commands.html).

## Advanced Topics

Expand Down
Loading