[PATCH gpgme v2] doc: clarify patch submission workflow
Thorsten Behrens
Thorsten.Behrens at CIB.de
Fri Feb 2 00:34:50 CET 2018
Signed-off-by: Thorsten Behrens <Thorsten.Behrens at CIB.de>
Co-authored-by: Todd Zullinger <tmz at pobox.com>
---
doc/HACKING | 31 +++++++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
diff --git a/doc/HACKING b/doc/HACKING
index 83c0f517..2478f8b3 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -89,6 +89,37 @@
It is recommended to send the patches using a PGP/MIME signed
mail.
+** Sending patches
+
+ - submitting patches, and subsequent discussions around them,
+ happens via the gnupg-devel at gnupg.org public mailing list
+
+ - send your patches to that list, preferably PGP/MIME signed. Make
+ sure to include a mention of 'gpgme' in the subject line,
+ the list is used for several different projects
+
+ - if you're working from the git repo, here's a suggested workflow:
+
+ - configure git send-email defaults:
+
+ git config format.subjectPrefix 'PATCH gpgme'
+ git config sendemail.to gnupg-devel at gnupg.org
+
+ - 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 --dry-run to test your setup
+
** Coding standards
Please follow the GNU coding standards. If you are in doubt consult
--
2.13.6
More information about the Gnupg-devel
mailing list