changeset 5:b8fe6bc8bb36

Add note about patchbomb
author David Demelier <markand@malikania.fr>
date Sun, 05 Feb 2017 21:20:03 +0100
parents b01540d74084
children 41dac98beeb2
files CONTRIBUTE.md
diffstat 1 files changed, 32 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/CONTRIBUTE.md	Fri Feb 03 10:52:29 2017 +0100
+++ b/CONTRIBUTE.md	Sun Feb 05 21:20:03 2017 +0100
@@ -21,6 +21,37 @@
 list. You need to subscribe by dropping a mail to
 *PROJECT NAME+subscribe (at) malikania (dot) fr* first.
 
+Enable patchbomb extension
+--------------------------
+
+While this step is optional, it brings the `hg email` command which makes most
+of your submission for you.
+
+To enable it, add the following into your .hgrc (you may also use the hgrc file
+from the repository in .hg/hgrc).
+
+    [extensions]
+    patchbomb =
+
+Then, you need to specify a mail server, if you want to use smtp, you can use
+something like this:
+
+    [email]
+    from = Your Name <youraddress@yourdomain.tld>
+    to = PROJECT NAME (at) malikania (dot) fr
+
+    [smtp]
+    host = yourdomain.tld
+    port = 25
+    tls = starttls
+
+More options are available, see:
+
+  - `hg help hgrc.email`,
+  - `hg help hgrc.smtp`,
+  - `hg help patchbomb`
+  - `hg help email`
+
 Create your patch
 -----------------
 
@@ -127,7 +158,7 @@
 repository, you can remove the revisions you have commited or keep them.
 
 If you want to remove the revisions, you can use the `hg strip` command (from
-the strip extension.
+the strip extension).
 
 **Warning**: it will **remove** the revisions from history so use with care.