diff options
| author | Werner Koch <wk@gnupg.org> | 2021-03-11 13:05:10 +0100 |
|---|---|---|
| committer | Werner Koch <wk@gnupg.org> | 2021-03-11 13:05:10 +0100 |
| commit | 6976a70270e3450557e553ad8dbab0587f0b0de1 (patch) | |
| tree | 81df9f9c5a2367a0d3276214fd4e8fd799d0a2e3 /doc/HACKING | |
| parent | doc: Always use --edit-key and not just the --edit abbreviation. (diff) | |
| download | gnupg2-6976a70270e3450557e553ad8dbab0587f0b0de1.tar.xz gnupg2-6976a70270e3450557e553ad8dbab0587f0b0de1.zip | |
doc: Add a sending patches section to HACKING.
--
This is based on a patch by
Co-authored-by: Thorsten Behrens <Thorsten.Behrens@CIB.de>
Co-authored-by: Todd Zullinger <tmz@pobox.com>
regarding Libassuan sent to gnupg-devel on 2018-02-02
Diffstat (limited to 'doc/HACKING')
| -rw-r--r-- | doc/HACKING | 41 |
1 files changed, 40 insertions, 1 deletions
diff --git a/doc/HACKING b/doc/HACKING index eb46d50c9..b3f9bbfab 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -119,7 +119,8 @@ Note that such a comment will be removed if the git commit option - That's it. From now on you only need to add a "Signed-off-by:" line with your name and mail address to the commit message. It is - recommended to send the patches using a PGP/MIME signed mail. + recommended to send the patches using a PGP/MIME signed mail. See + below on how to send patches. ** Coding standards @@ -232,6 +233,44 @@ Note that such a comment will be removed if the git commit option - Backported-from-master :: Value is the commit id of the original patch. - Ported-from-stable :: Value is the commit id of the original patch. +** Sending patches +Submitting patches, and subsequent discussions around them, +happens via the gnupg-devel@gnupg.org public mailing list. + +Send your patches to that list, preferably PGP/MIME signed. Make sure +to include a mention of 'gnupg' (or gpgme, libassuan, etc) in the +subject line; the list is used for several different projects. + +In general you should send patches only for the master branch; we may +later decide to backport to another branch. Please ask first before +sending pacthes for another branch. + +If you're working from the Git repo, here's a suggested workflow: + + - Configure git send-email defaults: + + : git config format.subjectPrefix 'PATCH gnupg' + : git config sendemail.to gnupg-devel@gnupg.org + + (For other sub-projects adjust accordingly) + + - hack hack hack + + - Commit your changes; group changes into easily-reviewable commit + units, feel free to submit several patches at once. + + e.g. if you want to submit a single patch on top of master, do: + : git send-email --annotate -1 + + e.g. if you have two commits on top of master, do: + : git send-email --annotate --cover-letter -2 + + (that prompts you for a summary mail to precede your actual patch + mails) + + - use Git's --dry-run option to test your setup + + * Windows ** How to build an installer for Windows |