[Cubicweb] [PATCH RFC] Add a "Contributing" section to README with patch submission guidelines

Arthur Lutz arthur.lutz at logilab.fr
Thu Feb 23 15:32:59 CET 2017

Not too used to reviewing code via email, I'm not sure about this
change, but I'll vote neutral or abstain.

One question : this applies to cubicweb's core, what about cubes ? We
keep the vcreview-based workflow ?


On 21/02/2017 11:18, Denis Laxalde wrote:
> # HG changeset patch
> # User Denis Laxalde <denis.laxalde at logilab.fr>
> # Date 1487671459 -3600
> #      Tue Feb 21 11:04:19 2017 +0100
> # Node ID 528743654af9e82769faab88fe56de6825dc32c5
> # Parent  f85ec84355db8499e235f7fedc80863333c23d58
> 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.
> diff --git a/README b/README
> --- a/README
> +++ b/README
> @@ -35,3 +35,16 @@ Look in the doc/ subdirectory or read ht
>  CubicWeb includes the Entypo pictograms by Daniel Bruce — www.entypo.com
> +
> +Contributing
> +------------
> +
> +Patches should be submitted by email at the cubicweb-devel at lists.cubicweb.org
> +mailing list in order to get reviewed by project integrators or any community
> +member.
> +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.
> _______________________________________________
> Cubicweb mailing list
> Cubicweb at lists.cubicweb.org
> https://lists.cubicweb.org/mailman/listinfo/cubicweb

Arthur Lutz - Logilab
http://www.logilab.fr/  http://www.logilab.fr/id/arthur.lutz
Téléphone +33 1 45 32 03 12
Twitter   @arthurlutz https://twitter.com/arthurlutz
          @logilab https://twitter.com/logilab

More information about the Cubicweb mailing list