Add a "Contributing" section to README with patch submission guidelines 3.25
authorDenis Laxalde <>
Tue, 21 Feb 2017 11:04:19 +0100
changeset 12141 29d032bb70d8
parent 12140 20035170160c
child 12142 db2fc87348ab
Add a "Contributing" section to README with patch submission guidelines For the CubicWeb project and its dependencies, we now prefer patches submission and review by email on a public mailing list. We are thus moving away from the previous vcreview-based workflow taking place on the forge. This change is motivated by the following points: - the current reviewer assignment mechanism (pick a random reviewer, rely on reviewer availability rather than on willingness to review, send related patches to distinct people, etc.) is inefficient if not counter-productive; - most of the times, discussion only happens between the patch submitter and a reviewer with no easy way to increase the audience; - cubicweb-vcreview has no concept of patch series; - cubicweb-vcreview is not actively maintained anymore and its usability keeps deteriorating. We expect that email-based submission and review of patches will circumvent these limitations. Anybody interested in the project is welcome to subscribed to the mailing list and participate to the review process. This patch documents the basic workflow of patches submissions by email.
--- a/README	Tue Apr 04 11:41:23 2017 +0200
+++ b/README	Tue Feb 21 11:04:19 2017 +0100
@@ -35,3 +35,16 @@
 CubicWeb includes the Entypo pictograms by Daniel Bruce —
+Patches should be submitted by email at the
+mailing list in order to get reviewed by project integrators or any community
+The simplest way of send patches is to use the ``hg email`` command available
+through the *patchbomb* extension of Mercurial. Preferably, patches should be
+*in the message body* of emails. When submitting a revised version of a patch
+series, a prefix indicating the iteration number ``<n>`` of the series should
+be added to email subject prefixes; this can be achieved by specifying a
+``--flag v<n>`` option to ``hg email`` command.