External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 13:45:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
62658bbf06
libvirt/docs/hacking.rst

104 lines
3.8 KiB
ReStructuredText
Raw Normal View History

docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
============
Contributing
============
These are the basics steps you need to follow to contribute to
docs: Link main "contributing" from programming-specific guide There are two guides to contributing: `hacking.rst` is focused on code contributions, and `contributing.rst` is more general. Clarify scope of `hacking.rst` and link to the general guide in its references. Signed-off-by: Tim Small <tim@seoss.co.uk> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2023-07-13 10:59:57 +00:00
libvirt software development.
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
Repositories and external resources
===================================
The official upstream repository is kept in git
docs: point to GitLab as the primary git hosting We still point to git repositories hosted on libvirt.org in various places. Replace the links to their gitlab.com equivalents. Note that GitLab is trying to be smart here and https://gitlab.com/libvirt/libvirt redirects to https://gitlab.com/libvirt/libvirt.git when doing a 'git clone' and vice-versa when visiting from the browser, so I only kept the .git suffix in places that explicitly mentioned 'git clone'. Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-06-03 10:42:34 +00:00
(``https://gitlab.com/libvirt/libvirt``) and is browsable
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
along with other libvirt-related repositories (e.g.
docs: point to GitLab as the primary git hosting We still point to git repositories hosted on libvirt.org in various places. Replace the links to their gitlab.com equivalents. Note that GitLab is trying to be smart here and https://gitlab.com/libvirt/libvirt redirects to https://gitlab.com/libvirt/libvirt.git when doing a 'git clone' and vice-versa when visiting from the browser, so I only kept the .git suffix in places that explicitly mentioned 'git clone'. Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-06-03 10:42:34 +00:00
libvirt-python) `online <https://gitlab.com/libvirt>`__.
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
po: update docs to refer to Weblate instead of Zanata The old information about managing PO files was outdated, as we're managing files in a different way with Weblate. This also introduces a badge showing the translation progress across languages. Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-06-04 22:01:25 +00:00
Patches to translations are maintained via the `Fedora Weblate
service <https://translate.fedoraproject.org/projects/libvirt/libvirt>`__.
Fix a typo in hacking.rst: "contirbute" -> "contribute" Signed-off-by: Matt Coleman <matt@datto.com> Reviewed-by: Neal Gompa <ngompa13@gmail.com> Reviewed-by: Erik Skultety <eskultet@redhat.com>
2020-09-08 20:43:54 +00:00
If you want to contribute to translations of libvirt, join the appropriate
po: update docs to refer to Weblate instead of Zanata The old information about managing PO files was outdated, as we're managing files in a different way with Weblate. This also introduces a badge showing the translation progress across languages. Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2020-06-04 22:01:25 +00:00
language team in Weblate. Translation updates to libvirt will be merged
during the feature freeze window.
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
docs: Point to compiling guide from code contribution guide The "hacking" doc details where to find the code, but not how to compile it - link to the instructions contained in `compiling.rst`. Signed-off-by: Tim Small <tim@seoss.co.uk> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2023-07-13 10:59:58 +00:00
Working with the code
=====================
In general you should base your work upon the git master branch.
The `"Git checkout" section <compiling.html#git-checkout>`__
of the libvirt installation instructions give an overview of the
compilation process.
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-13 10:59:59 +00:00
Optionally, `Clangd with libvirt <clangd.html>`__ can be used to
navigate the code base etc. within most code editors (and IDEs).
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
Preparing patches
=================
docs: Reword "Preparing Patches" to clarify Clarify that patches should apply cleanly to the master branch. Give guidance for typical bug fix process for existing releases. Signed-off-by: Tim Small <tim@seoss.co.uk> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2023-07-13 11:00:00 +00:00
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.
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
Run the automated tests on your code before submitting any
changes. That is:
::
meson: adjust our documentation to mention meson instead of autoconf Signed-off-by: Pavel Hrdina <phrdina@redhat.com> Reviewed-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Neal Gompa <ngompa13@gmail.com>
2020-07-17 19:09:25 +00:00
$ ninja test
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
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 <coding-style.html>`__.
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 <news.html>`__ if your
changes are significant and user-visible.
docs: Advise running CI tests prior to submission In the preparing patches section, note that it is possible to run CI tests via gitlab prior to submitting patches. Signed-off-by: Tim Small <tim@seoss.co.uk> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2023-07-13 11:00:01 +00:00
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 <ci.html>`__ test suite.
Please note that you should still follow the instructions below,
rather than following gitlab's prompts to open a "merge request".
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
Submitting patches
==================
Libvirt uses a mailing list based development workflow.
While preparing your patches for submissions, make sure you
follow the `best practices <best-practices.html>`__ and, once
you're satisfied with the result, go ahead and
`submit your patches <submitting-patches.html>`__.
Developer Certificate of Origin
===============================
Contributors to libvirt projects **must** assert that they are
in compliance with the `Developer Certificate of Origin
1.1 <https://developercertificate.org/>`__. This is achieved by
adding a "Signed-off-by" line containing the contributor's name
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-22 09:38:58 +00:00
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.
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
Further reading
===============
This page only covers the very basics, so it's recommended that
you also take a look at the following documents:
- `Programming languages <programming-languages.html>`__
- `Advanced test suite usage <advanced-tests.html>`__
Revert "docs: Drop glib-adoption.rst" Cleaning up after Andrea as he requested: https://www.redhat.com/archives/libvir-list/2020-May/msg00405.html This reverts commit 842d3712ed612f213b454e610cc7ff9db2321803 Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Andrea Bolognani <abologna@redhat.com>
2020-09-24 07:11:17 +00:00
- `Adoption of GLib APIs <glib-adoption.html>`__
docs: Update hacking.rst This organizes the existing contents into sections, tweaks some parts a bit and adds links to the pages where the contents that were ripped out of hacking.rst now live, either inline or in the catch-all "further reading" section depending on what makes more sense. The result is that it's now possible to consume this page, which is the entry point for new contributors, in just a few minutes, and then drill down further based on factors such as the familiarity with the open source development model or mail-based workflows. Signed-off-by: Andrea Bolognani <abologna@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-04-06 14:59:48 +00:00
- `Committer guidelines <committer-guidelines.html>`__
docs: Link main "contributing" from programming-specific guide There are two guides to contributing: `hacking.rst` is focused on code contributions, and `contributing.rst` is more general. Clarify scope of `hacking.rst` and link to the general guide in its references. Signed-off-by: Tim Small <tim@seoss.co.uk> Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
2023-07-13 10:59:57 +00:00
- `Contributing to libvirt <contribute.html>`__
Reference in New Issue Copy Permalink