Changes between Version 8 and Version 9 of UfoRevisionControl

Timestamp:

Sep 6, 2011, 7:03:51 PM (13 years ago)

Author:

Matthias Vogelgesang

Comment:

Propose a canonical commit message format

UfoRevisionControl

@@ -20 +20 @@
 {{{
 bzr branch bzr+ssh://user@ufo.kit.edu/vogelgesang/PyHST
+}}}
+
+== Committing changes ==
+
+Any changes that you make, are ''locally'' stored with the commit command
+{{{
+bzr commit
+}}}
+which asks you for a commit message.
+
+Similar to Git, Bazaar handles the very first line of a commit message in a
+special way. For example `bzr log --line` prints the whole log with revision number,
+author, date and first line. To keep things nice and tidy, this first line
+should ''summarize'' the commit in ''50'' characters or less. To increase
+readability of these lines you may use the `<prefix>: <description>` format,
+with the following possible prefixes:
+
+* Fix (e.g. `Fix: segmentation fault` or `Fix: bug #1234`)
+* Add (e.g. `Add: web interface`)
+* Update (e.g. `Update: version`)
+
+Because, this line is limited to only 50 characters, you can use several
+paragraphs divided by newlines to explain not only ''what'' you did, but more
+importantly ''why'' you changed something. These paragraphs must be wrapped
+at 72 characters.
+
+You should definately make use of Bazaar's builtin bug-tracker support. To
+enable this for the UFO project add this line to your `bazaar.conf` (located in
+`~/.bazaar`):
+
+{{{
+[DEFAULT]
+trac_ufo_url = http://ufo.kit.edu/ufo
+}}}
+
+Now, for each bug that has an associated ticket, you can mark the fixing commit
+with
+{{{
+bzr commit --fixes ufo:123
 }}}
 
@@ -55 +94 @@
   bzr bind bzr+ssh://user_name@ufo.kit.edu/user_name/branch1
 }}}
+
+
 
 [[BR]]