[Orca-checkins] r279 - trunk/orca

[Blair Zajac]

Author: blair
Date: Mon Jan 26 15:09:14 2004
New Revision: 279

Modified:
   trunk/orca/HACKING
Log:
Document the convention of starting each log message with a summary line.

* HACKING
  (Writing log messages): Describe the convention, explain about CIA.


Modified: trunk/orca/HACKING
==============================================================================
--- trunk/orca/HACKING	(original)
+++ trunk/orca/HACKING	Mon Jan 26 15:09:14 2004
@@ -222,6 +222,12 @@
 you've only changed comments, write a log that says "Doc fix." or
 something.
 
+Start off the log message with one line indicating the general nature
+of the change.  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.  (See http://cia.navi.cx/ for details.)
+
 Use full sentences, not sentence fragments.  Fragments are more often
 ambiguous, and it takes only a few more seconds to write out what you
 mean.  Fragments like "Doc fix", "New file", or "New function" are