[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

RFC: change to HACKING guidelines on log messages

From: <kfogel_at_collab.net>
Date: 2004-10-04 16:28:14 CEST

In r11227, I made the following change:

  * HACKING (Writing Log Messages): Specify looser guidelines for
    translation or documentation log messages, based on feedback from
    Grzegorz Adam Hankiewicz <gradha@titanium.sabren.com> in thread:

    http://subversion.tigris.org/servlets/BrowseList?\
    list=dev&by=thread&from=202584
    In particular: <20041003171242.GA16647@hankiewicz.datanet.co.uk>

    [see the diff at the end of this mail]

Since this might be controversial, I wanted to solicit feedback from
other developers here. If there isn't consensus that this loosening
of the log message guidelines is a Good Thing, then we should discuss,
and I'll certainly be happy to revert if necessary.

Thanks,
-Karl

Index: HACKING
===================================================================
--- HACKING (revision 11226)
+++ HACKING (revision 11227)
@@ -911,7 +911,8 @@
 Writing log messages
 ====================
 
-Certain guidelines should be adhered to when writing log messages:
+Certain guidelines should be adhered to when writing log messages for
+code changes:
 
 Make a log message for every change. The value of the log becomes
 much less if developers cannot rely on its completeness. Even if
@@ -1041,7 +1042,16 @@
 considerate of your fellow developers. (Also, run "svn log" to see
 how others have been writing their log entries.)
 
+Log messages for documentation or translation have somewhat looser
+guidelines. The requirement to name every symbol obviously does not
+apply, and if the change is just one more increment in a continuous
+process such as translation, it's not even necessary to name every
+file. Just briefly summarize the change, for example: "More work on
+Malagasy translation of the book." When you finish a distinct stage
+of work, note it in the log message, for example: "Finish Chapter 3 of
+Malagasy book translation."
 
+
 
 Patch submission guidelines
 ===========================

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Mon Oct 4 18:15:32 2004

This is an archived mail posted to the Subversion Dev mailing list.