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.
CubicWeb semantic web framework===============================CubicWeb is a entities / relations based knowledge management systemdevelopped at Logilab.This package contains:- a repository server- a RQL command line client to the repository- an adaptative modpython interface to the server- a bunch of other management toolsInstall-------More details at https://cubicweb.readthedocs.io/en/3.25/book/admin/setupGetting started---------------Execute:: apt-get install cubicweb cubicweb-dev cubicweb-blog cubicweb-ctl create blog myblog cubicweb-ctl start -D myblog sensible-browser http://localhost:8080/Details at https://cubicweb.readthedocs.io/en/3.25/tutorials/base/blog-in-five-minutesDocumentation-------------Look in the doc/ subdirectory or read https://cubicweb.readthedocs.io/en/3.25/CubicWeb includes the Entypo pictograms by Daniel Bruce — http://www.entypo.comContributing------------Patches should be submitted by email at the cubicweb-devel@lists.cubicweb.orgmailing list in order to get reviewed by project integrators or any communitymember.The simplest way of send patches is to use the ``hg email`` command availablethrough the *patchbomb* extension of Mercurial. Preferably, patches should be*in the message body* of emails. When submitting a revised version of a patchseries, a prefix indicating the iteration number ``<n>`` of the series shouldbe added to email subject prefixes; this can be achieved by specifying a``--flag v<n>`` option to ``hg email`` command.