[Erp5-dev] short commit summary as the first line of the message

[Jean-Paul Smets]

Hi,

Please also look at this page:
    http://www.erp5.org/GuidelinesForBestCommitPractices

Regards,

JPS.

Boris Kocherov a écrit :
> Hi.
>
> This is bad style practice:
> http://svn.erp5.org/?view=rev&revision=23436
> http://svn.erp5.org/?view=rev&revision=22910
> http://svn.erp5.org/?view=rev&revision=21483
>
> Excellent style practice:
> http://svn.erp5.org/?view=rev&revision=21048
>
> Some quotes:
> * " Start it off with one line indicating the general nature of the 
> change, and follow
>    that with a descriptive paragraph if necessary. This not only helps 
> put developers
>    in the right frame of mind for reading the rest of the log message, 
> but also plays well
>    with the "CIA" bot that echoes the first line of each commit to 
> realtime forums like IRC. "
>    http://subversion.tigris.org/hacking.html
>
> * "it is customary to have a short commit summary as the first line of 
> the message"
>    http://git.or.cz/course/svn.html
>
> * "Bazaar, like all other modern VCS tools, uses the first line of the 
> commit message
>    as the summary which appears in email Subject: lines, the |--line| 
> output to |bzr log|, etc.
>    So a descriptive yet concise first line is important."
>    http://java-gnome.sourceforge.net/4.0/doc/style/CommitMessages.html
> _______________________________________________
> Erp5-dev mailing list
> Erp5-dev at erp5.org
> http://mail.nexedi.com/mailman/listinfo/erp5-dev
>   


-- 
Jean-Paul Smets-Solanes, Nexedi CEO - Tel. +33(0)6 62 05 76 14
ERP5 Enterprise: Free / Open Source ERP for Critical Applications
http://www.erp5.com
ERP5 Express: Hosted Open Source ERP for small companies
http://www.myerp5.com
Nexedi: Consulting and Development of Free / Open Source Software 
http://www.nexedi.com