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.

     1

CubicWeb semantic web framework

     2

===============================

     3

     4

CubicWeb is a entities / relations based knowledge management system

     5

developped at Logilab.

     6

     7

This package contains:

     8

     9

- a repository server

    10

- a RQL command line client to the repository

    11

- an adaptative modpython interface to the server

    12

- a bunch of other management tools

    13

    14

Install

    15

-------

    16

    17

More details at https://cubicweb.readthedocs.io/en/3.25/book/admin/setup

    18

    19

Getting started

    20

---------------

    21

    22

Execute::

    23

    24

 apt-get install cubicweb cubicweb-dev cubicweb-blog

    25

 cubicweb-ctl create blog myblog

    26

 cubicweb-ctl start -D myblog

    27

 sensible-browser http://localhost:8080/

    28

    29

Details at https://cubicweb.readthedocs.io/en/3.25/tutorials/base/blog-in-five-minutes

    30

    31

Documentation

    32

-------------

    33

    34

Look in the doc/ subdirectory or read https://cubicweb.readthedocs.io/en/3.25/

    35

    36

    37

CubicWeb includes the Entypo pictograms by Daniel Bruce — http://www.entypo.com

    38

    39

Contributing

    40

------------

    41

    42

Patches should be submitted by email at the cubicweb-devel@lists.cubicweb.org

    43

mailing list in order to get reviewed by project integrators or any community

    44

member.

    45

The simplest way of send patches is to use the ``hg email`` command available

    46

through the *patchbomb* extension of Mercurial. Preferably, patches should be

    47

*in the message body* of emails. When submitting a revised version of a patch

    48

series, a prefix indicating the iteration number ``<n>`` of the series should

    49

be added to email subject prefixes; this can be achieved by specifying a

    50

``--flag v<n>`` option to ``hg email`` command.