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

Boris Kocherov bkocherov at gmail.com
Fri Sep 5 00:54:11 CEST 2008


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



More information about the Erp5-dev mailing list