[muine] Rename ChangeLog and mention new rules in ChangeLog.README



commit 100f68a1fd589c2a032fdb95c6807f9898819e88
Author: Priit Laes <plaes plaes org>
Date:   Thu Aug 27 08:49:16 2009 +0300

    Rename ChangeLog and mention new rules in ChangeLog.README
    
    * ChangeLog.20090722, ChangeLog.README:

 ChangeLog => ChangeLog.20090722 |    0
 ChangeLog.README                |   28 ++++++++++++++++++++++++++++
 2 files changed, 28 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog.20090722
similarity index 100%
rename from ChangeLog
rename to ChangeLog.20090722
diff --git a/ChangeLog.README b/ChangeLog.README
new file mode 100644
index 0000000..8b76ade
--- /dev/null
+++ b/ChangeLog.README
@@ -0,0 +1,28 @@
+Muine doesn't use ChangeLog anymore. Instead, we use Git checkin comments
+to autogenerate a ChangeLog file at "make dist" time.
+
+When committing a patch to git, you must use a checkin comment that fully
+describes the changes made. If the checkin is related to a bug, reference
+the bug number. Example:
+
+        When removing a toolbar, make its items available again in the toolbar
+        editor. (Bug #123456)
+
+Checkin comments MUST use the UTF-8 encoding.
+
+If you forget to check in some changes that belonged in the same commit (e.g.
+you accidentally omitted a file), you must copy the checkin comment from the
+previous, incomplete checkin, and additionally reference that commit's svn
+revision number.
+
+DO NOT use meaningless checkin comments such as "forgotten file" !
+
+If you make a major mistake in the checkin comment (e.g it is empty, or
+you've forgotten to cite the bug numbers), you must create a new checkin
+that touches all files the original checkin changed (just using whitespace
+changes preferably, or fix a random typo), and in the new checkin comment
+you must note that this new checkin fixes the original checkin, referencing
+it by its SVN revision number.
+
+Do NOT commit to this module without permission from a maintainer.
+See the MAINTAINERS file for who they are.



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]