mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-12 12:55:46 +00:00

Tim Small 3da8d8b5b1 docs: Add config instructions for clangd with libvirt

In build environments which use gcc as the default compiler, use of the
clangd LSP server (for enhanced code editing and navigation etc.) with
libvirt requires some additional configuration.  Detail this and link
from `hacking.rst`.

Signed-off-by: Tim Small <tim@seoss.co.uk>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

2023-07-14 15:19:19 +02:00

3.1 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 libvirt git. Developers only follow git and don't care much about released versions.

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.

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 presence of this line attests that the contributor has read the above lined DCO and agrees with its statements.

3.1 KiB Raw Blame History