Git-Mirrors/shufflecake
1
0
Fork 0
mirror of https://codeberg.org/shufflecake/shufflecake-c.git synced 2026-01-06 19:15:38 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc:Add CONTRIBUTING.md and changed AUTHORS

Browse source
This commit is contained in:
Tommaso Gagliardoni 2025-01-08 12:35:43 +01:00
parent bc51f0ad99
commit 942270dbd4
2 changed files with 72 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
AUTHORS
View file

@ -1,13 +1,15 @@
A copy of this file is maintained at <https://www.shufflecake.net/permalinks/shufflecake-c/AUTHORS>. The program shufflecake-c is part of the Shufflecake Project. Shufflecake is a plausible deniability (hidden storage) layer for Linux. See <https://www.shufflecake.net>.
List of contributors to shufflecake-c in alphabetical order, followed by year of first copyright assignment:
Benjamin Voisin <benjamin.voisin@ens-rennes.fr> (2025)
Copyright Elia Anzuoni <elianzuoni@gmail.com> (2022)
Copyright Tommaso Gagliardoni <tommaso@gagliardoni.net> (2022)
Copyright Nagravision Sàrl (2022)
Copyright Tommaso Gagliardoni <tommaso@gagliardoni.net> (2022)
Shufflecake was originally created by the following authors:
Copyright Elia Anzuoni <elianzuoni@gmail.com> (2022)
Copyright Tommaso Gagliardoni <tommaso@gagliardoni.net> (2022)
Copyright Elia Anzuoni <elianzuoni@gmail.com>
Copyright Tommaso Gagliardoni <tommaso@gagliardoni.net>

67
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,67 @@
# How to contribute to shufflecake-c
Thank you for your interest in contributing! These guidelines are subject to change, so please check before submitting a contribution.
We do not accept anonymous contributions: please use your full legal name when submitting, or anyway make it clearly visible in text.
We are flexible in the way we accept contributions, although the best way is to submit a pull request through Codeberg.
Please be verbose and accurate regarding what your contributions does and how, it will make our review process easier.
The important thing, however, is to manage copyright assignment. Many small open source projects do not really care about this, but given the nature of the Shufflecake Project, we want to avoid ambiguous legal situations. Shufflecake is, and will always be, fully FOSS/Libre. Distributing copyright across all the contributors aims to avoid a scenario where a few people, even us (the maintainers) could collude at any point in the future to arbitraily change the software license to a commercial or non-free one. For this reason, the Shufflecake Project will never ask contributors to sign a Contributor License Agreement (CLA) or a Copyright Transfer Agreement (CTA). However, since in many cases contributors do not have full freedom in retaining the copyright of the code they contribute to, we ask contributors to sign off a Developer Certificate of Origin (DCO), the text of which you can find at https://developercertificate.org/ but we report it here below for completeness:
```
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
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.
```
## In practice
1. Make sure you have a PGP key to sign off your contributions.
1. The key must be minimum 2048 bit RSA or equivalent/above security level.
2. It must contain an identity with your full legal name.
3. It must be publicly available (i.e., upload it on a public keyserver).
3. If it's a key that you use specifically for signig off Shufflecake contributions, make sure it is signed by a key which is publicly linkable to you (e.g., your main PGP key on a keyserver).
2. Configure the key to be used on Codeberg.
1. Import the public part of the key in your Codeberg profile (Settings -> SSH/OpenPGP Keys).
2. Use the key to sign your commits.
3. Use the `-s` flag when committing your contribution to Shufflecake.
4. IMPORTANT: merge in the `dev` branch, or another, ad hoc branch. Do not try to merge into `main`.
3. If you submit your contribution differently, you can send us a PGP-signed email where you confirm your acceptance of the DCO in regard to your contribution.
1. Include a mention of your contribution, e.g. a description in text, or commit hash).
4. Once your contribution has been reviewed and merged, your name will be added to the list of contributors to the `AUTHORS` file in this directory.