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.
Javascript Coding Standards
---------------------------
(Draft, to be continued)
:Naming: camelCase, except for CONSTANTS
Indentation rules
~~~~~~~~~~~~~~~~~
- espace avant accolade ouvrante
- retour à la ligne après accolade ouvrante (éventuellement pas
de retour à la ligne s'il y a tout sur la même ligne, mais ce n'est
pas le cas ici.
- no tabs
Documentation
~~~~~~~~~~~~~
XXX explain comment format for documentation generation
Coding
~~~~~~
- Don't forget 'var' before variable definition, and semi-colon (';') after **each** statement.
- Check the firebug console for deprecation warnings
API usage
~~~~~~~~~
- unless intended, use jQuery('container') rather than jqNode('container')
See also
~~~~~~~~
http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml