Do not use ChangeLog file any more

Bug #583421. With move to git, do not use ChangeLog anymore.

diff --git a/ChangeLog b/ChangeLog
index 81e153d..b5020b7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+=== ChangeLog discontinued ===
+
+       With the move to git, atk is switching from a ChangeLog file
+       to relying on commit messages to provide change history. Please
+       see README.commits for guidance on the expected message format.
+
 2009-03-19  Li Yuan  <liyuan@goaltender>
 
        Patch from Yue Wang. Bug #575794.

diff --git a/README.commits b/README.commits
new file mode 100644 (file)
index 0000000..2f51f88
--- /dev/null
+++ b/README.commits
@@ -0,0 +1,29 @@
+Atk is part of the GNOME git repository. With git, we no longer
+maintain a ChangeLog file, but you are expected to produce a meaningful
+commit message. Changes without a sufficient commit message will be
+reverted. The expected format for git commit messages is as follows:
+
+=== begin example commit ===
+Short explanation of the commit
+
+Longer explanation explaining exactly what's changed, whether any
+external or private interfaces changed, what bugs were fixed (with bug
+tracker reference if applicable) and so forth. Be concise but not too brief.
+=== end example commit ===
+
+  - Always add a brief description of the commit to the _first_ line of
+    the commit and terminate by two newlines (it will work without the
+    second newline, but that is not nice for the interfaces).
+
+  - First line (the brief description) must only be one sentence and
+    should start with a capital letter unless it starts with a lowercase
+    symbol or identifier. Don't use a trailing period either. Don't exceed
+    72 characters.
+
+  - The main description (the body) is normal prose and should use normal
+    punctuation and capital letters where appropriate. Normally, for patches
+    sent to a mailing list it's copied from there.
+
+  - When committing code on behalf of others use the --author option, e.g.
+    git commit -a --author "Joe Coder <joe@coder.org>" and --signoff.
+