[31669] trunk/base/HACKING

[jmpp at macports.org]

Revision: 31669
          http://trac.macosforge.org/projects/macports/changeset/31669
Author:   jmpp at macports.org
Date:     2007-12-02 10:09:13 -0800 (Sun, 02 Dec 2007)

Log Message:
-----------

Include hacking rules for commits to base with respect to the ChangeLog file

NOTE: Needless to say, I'm more than open to suggestions to improve the fluency of this policy.

Modified Paths:
--------------
    trunk/base/HACKING

Modified: trunk/base/HACKING
===================================================================
--- trunk/base/HACKING	2007-12-02 17:28:53 UTC (rev 31668)
+++ trunk/base/HACKING	2007-12-02 18:09:13 UTC (rev 31669)
@@ -1,4 +1,4 @@
-Project naming and copyright attribution:
+# Project naming and copyright attribution:
 
 * "The MacPorts Project" is the string that shall be used whereever there's a need to reference our project name, such as in copyright notices.
 * A developer or contributor is advised to attribute himself a copyright notice if he/she is contributing a full new source file or a full new feature
@@ -9,8 +9,20 @@
   being uploaded to the "base" component of our repository, since as such they are being contributed to the project.
 
 
-Whitespace rules as discussed on the development list (macports-dev):
+# Commits to the "base" component of the repository:
 
+* Any commit made to the "base" component of the repository should be accompanied by a corresponding entry in the base/ChanegeLog file, full with information
+    of the svn revision information of the commit and Trac ticket number the commit references and/or fixes, if any.
+* Such entries to the ChangeLog need not be full duplications of their related commit logs if the latter are thorough explanations of what's involved in the commit.
+    In such cases it's perfectly acceptable to enter just a summary of the commit and point the reader to further information through the related svn revision
+    and Trac ticket number (if applicable).
+* Related commits to "base" may be grouped in a single ChangeLog entry, provided the full list of svn revisions and Trac ticket numbers referenced (if applicable)
+    is included.
+* Commits to "base" need not update the base/NEWS file, as such will be constructed with the relevant information at MacPorts release time by the release engineers.
+
+
+# Whitespace rules as discussed on the development list (macports-dev):
+
 * All source code files MUST use soft tabs at a tabstop of 4. No hard tabs are allowed.
 * All source code files SHOULD have the following as the first line of the file:
     # -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:filetype=tcl:et:sw=4:ts=4:sts=4

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20071202/ffe78971/attachment.html