mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00

Daniel P. Berrangé 372d4b42d3 docs: permit a user's chosen identity with SoB

The docs for submitting a patch describe using your "Legal Name" with
the Signed-off-by line.

In recent times, there's been a general push back[1] against the notion
that use of Signed-off-by in a project automatically requires / implies
the use of legal ("real") names and greater awareness of the downsides.

Full discussion of the problems of such policies is beyond the scope of
this commit message, but at a high level they are liable to marginalize,
disadvantage, and potentially result in harm, to contributors.

TL;DR: there are compelling reasons for a person to choose distinct
identities in different contexts & a decision to override that choice
should not be taken lightly.

A number of key projects have responded to the issues raised by making
it clear that a contributor is free to determine the identity used in
SoB lines:

 * Linux has clarified[2] that they merely expect use of the
   contributor's "known identity", removing the previous explicit
   rejection of pseudonyms.

 * CNCF has clarified[3] that the real name is simply the identity
   the contributor chooses to use in the context of the community
   and does not have to be a legal name, nor birth name, nor appear
   on any government ID.

Since we have no intention of ever routinely checking any form of ID
documents for contributors[4], realistically we have no way of knowing
anything about the name they are using, except through chance, or
through the contributor volunteering the information. IOW, we almost
certainly already have people using pseudonyms for contributions.

This proposes to accept that reality and eliminate unnecessary friction,
by following Linux & the CNCF in merely asking that a contributors'
commonly known identity, of their choosing, be used with the SoB line.

[1] Raised in many contexts at many times, but a decent overall summary
    can be read at https://drewdevault.com/2023/10/31/On-real-names.html
[2] https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=d4563201f33a022fc0353033d9dfeb1606a88330
[3] https://github.com/cncf/foundation/blob/659fd32c86dc/dco-guidelines.md
[4] Excluding the rare GPG key signing parties for regular maintainers

Reviewed-by: Peter Krempa <pkrempa@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>

2024-10-28 12:29:31 +00:00

3.8 KiB

Raw Blame History

Contributing

These are the basics steps you need to follow to contribute to libvirt software development.

Repositories and external resources

The official upstream repository is kept in git (https://gitlab.com/libvirt/libvirt) and is browsable along with other libvirt-related repositories (e.g. libvirt-python) online.

Patches to translations are maintained via the Fedora Weblate service. If you want to contribute to translations of libvirt, join the appropriate language team in Weblate. Translation updates to libvirt will be merged during the feature freeze window.

Working with the code

In general you should base your work upon the git master branch.

The "Git checkout" section of the libvirt installation instructions give an overview of the compilation process.

Optionally, Clangd with libvirt can be used to navigate the code base etc. within most code editors (and IDEs).

Preparing patches

Make sure your patches apply against the libvirt git master branch. The backporting of changes to existing releases is typically carried out by downstream users at their discretion after code is merged into the upstream git.

Run the automated tests on your code before submitting any changes. That is:

$ ninja test

These tests help making sure that your changes don't introduce regressions in libvirt, as well as validating that any new code follows the project's coding style.

If you're going to submit multiple patches, the automated tests must pass after each patch, not just after the last one.

Update tests and/or documentation, particularly if you are adding a new feature or changing the output of a program, and don't forget to update the release notes if your changes are significant and user-visible.

To test across a variety of build platforms prior to submitting your changes, you may create your own fork of the project on gitlab. This will give you access to (a subset of) libvirt's continuous integration test suite.

Please note that you should still follow the instructions below, rather than following gitlab's prompts to open a "merge request".

Submitting patches

Libvirt uses a mailing list based development workflow.

While preparing your patches for submissions, make sure you follow the best practices and, once you're satisfied with the result, go ahead and submit your patches.

Developer Certificate of Origin

Contributors to libvirt projects must assert that they are in compliance with the Developer Certificate of Origin 1.1. This is achieved by adding a "Signed-off-by" line containing the contributor's name and e-mail to every commit message. The name should be the identity the contributor has chosen to be known as in the context of the community. It does not need to be a legal name, nor match any formal ID documents, but should not be anonymous, nor misrepresent who you are. The presence of this line attests that the contributor has read the above linked DCO and agrees with its statements.

3.8 KiB Raw Blame History