[PATCH gpgme] doc: clarify patch submission workflow

Todd Zullinger tmz at pobox.com
Thu Feb 1 21:47:02 CET 2018


Thorsten Behrens wrote:
> +   - 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:
> +
> +     - 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 --to=gnupg-devel at gnupg.org --annotate -1
> +       (please put a mention of gpgme into the subjects,
> +       annotate lets you do that)
> +
> +     - e.g. if you have two commits on top of master, do:
> +       git send-email --to=gnupg-devel at gnupg.org --annotate --cover-letter -2
> +       (that prompts you for a summary mail to precede your actual
> +       patch mails)
> +
> +     - use --dry-run to test your setup

Similar to libgpg-error, we can make it easier for
contributors to include a proper subject prefix
automatically.

Feel free to squash this in with or without attribution.  I
don't think this warrants a signoff or DCO from me, but I'm
happy to provide one if needed.

-->8--
diff --git i/doc/HACKING w/doc/HACKING
index 3d3a2adf..6eec319d 100644
--- i/doc/HACKING
+++ w/doc/HACKING
@@ -100,18 +100,21 @@
 
    - 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 --to=gnupg-devel at gnupg.org --annotate -1
-       (please put a mention of gpgme into the subjects,
-       annotate lets you do that)
+       git send-email --annotate -1
 
      - e.g. if you have two commits on top of master, do:
-       git send-email --to=gnupg-devel at gnupg.org --annotate --cover-letter -2
+       git send-email --annotate --cover-letter -2
        (that prompts you for a summary mail to precede your actual
        patch mails)
 
-- 
Todd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
People are crazy and times are strange
I'm locked in tight, I'm out of range
I used to care, but things have changed

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 543 bytes
Desc: not available
URL: <https://lists.gnupg.org/pipermail/gnupg-devel/attachments/20180201/707c961e/attachment.sig>


More information about the Gnupg-devel mailing list