gyrus r320 - trunk

[csaavedra svn gnome org]

Author: csaavedra
Date: Fri Jan 18 18:17:24 2008
New Revision: 320
URL: http://svn.gnome.org/viewvc/gyrus?rev=320&view=rev

Log:
2008-01-18  Claudio Saavedra  <csaavedra alumnos utalca cl>

	* HACKING: Add guidelines for working in the gyrus SVN.



Added:
   trunk/HACKING
Modified:
   trunk/ChangeLog

Added: trunk/HACKING
==============================================================================
--- (empty file)
+++ trunk/HACKING	Fri Jan 18 18:17:24 2008
@@ -0,0 +1,31 @@
+If you're interested on working on gyrus SVN, please follow carefully these
+guidelines.
+
+1. There must be a ChangeLog entry for every commit. This is mandatory, 
+   and commits without an entry will be reverted. The ChangeLog entry must
+   document properly the changes made.
+
+2. One commit, one change. Please do not fix multiple bugs with one commit, 
+   nor add unrelated features with one commit. If you are going to fix one
+   bug, add a feature, and improve text messages, do three different commits.
+   This way, you make life easier for people proof reading changes and 
+   studying possible regressions. Multiple changes in one commit will be 
+   reverted as well.
+
+3. Every commit must contain a SVN log message. For most of the changes, 
+   copying/pasting the ChangeLog entry is enough. If you are adding a few files
+   you forgot to add with previous commit, it's OK to add a short message, but
+   as a rule of thumb, use ChangeLog entries in doubt. Changes without 
+   SVN log message, will be reverted.
+
+4. It is strongly recommended to use this script [1] to generate ChangeLog
+   entries. Before committing, run it from the root directory of the project,	
+   and it will automatically add a nice entry with your name and current
+   date, plus the modified files/functions, for you to commit. Authors of 
+   malformed entries will be asked to fix them.
+
+5. Any consecutive transgression of above rules will mean the committer to get
+   their permissions to commit in gyrus revoked.
+
+[1] http://developer.gnome.org/tools/scripts/prepare-ChangeLog.pl.txt
+