Work better with git and other tools.

1 files changed, 28 insertions, 15 deletions

diff --git a/ChangeLog b/ChangeLog
index d65639d..0bd7f42 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,19 +1,32 @@
-0.5:
-    * Fix line off by one error.
+=== ChangeLog discontinued ===
 
-0.4:
-    * Add regexCounter variable for 64 bit values
-    * Fix assertion when selecting text at end of line
-    * Fix problems when large buffers come in at once with multiple lines.
+ With the move to git, this project is switching from a ChangeLog
+ file to relying on commit messages to provide change history. Please
+ write commit messages in the following format:
 
-0.3:
-    * Use my real name 'Stefan Walter':
-      See: http://memberwebs.com/nielsen/
+=== begin example commit ===
 
-0.2:
-    * Fix bug with an assert on long lines
-    * Better configure.in checks.
-    * Cleanup the MIB a bit
+ Short explanation of the commit
 
-0.1:
-    * Initial Release.
+ 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. This may be the title of
+ a fixed bug, copied from Bugzilla.
+
+ - 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 full stop,
+ and don't exceed 72 characters.
+
+ - The main description (the body) is normal prose and should use
+ normal punctuation and capital letters where appropriate.
+
+ - When committing code on behalf of others use the --author option,
+ e.g. git commit -a --author "Joe Coder <joe@coder.org>" and
+ --signoff.