diff --git a/HACKING b/HACKING index 36564118e58e675eb618ec958a85afaa73499cb3..1952856fb7f335b209525bfd83bb2835b4fa0eef 100644 --- a/HACKING +++ b/HACKING @@ -14,15 +14,21 @@ General tips for contributing patches (1) Discuss any large changes on the mailing list first. Post patches early and listen to feedback. + + (2) Official upstream repository is kept in git ("git://libvirt.org/libvirt.git") and is browsable along with other libvirt-related repositories (e.g. libvirt-python) online . + + (3) Patches to translations are maintained via the zanata project . If you want to fix a translation in a .po file, join the appropriate language team. The libvirt release process automatically pulls the latest version of each translation file from zanata. + + (4) Post patches using "git send-email", with git rename detection enabled. You need a one-time setup of: @@ -93,6 +99,8 @@ things). (7) Make sure your patches apply against libvirt GIT. Developers only follow GIT and don't care much about released versions. + + (8) Run the automated tests on your code before submitting any changes. In particular, configure with compile warnings set to -Werror. This is done automatically for a git checkout; from a tarball, use: @@ -238,6 +246,8 @@ feature or changing the output of a program. + + There is more on this subject, including lots of links to background reading on the subject, on Richard Jones' guide to working with open source projects . diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 13b3640259e9d939c4ce8e2f1395ae9361fd3e19..47475a25a37bc6806351deb0a78d8c9e3b1e81c1 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -289,8 +289,11 @@ } -
  • Update tests and/or documentation, particularly if you are adding - a new feature or changing the output of a program.
  • + +
  • +

    Update tests and/or documentation, particularly if you are adding + a new feature or changing the output of a program.

    +