diff options
| author | Vincent Untz <vuntz@gnome.org> | 2010-09-20 17:38:43 +0200 |
|---|---|---|
| committer | Vincent Untz <vuntz@gnome.org> | 2010-09-20 17:38:43 +0200 |
| commit | 2227d19f65ec398d84ac47c539250c2b6d67f907 (patch) | |
| tree | b65903f572c878ec2a10c5bf7e6d8d4bf70a4e48 | |
| parent | 7a16049bfbf3f9c63d15a4f62e25d222db121fb2 (diff) | |
misc: Update instructions for commit messages
We're switching to "tag:" instead of "[tag]".
| -rw-r--r-- | ChangeLog | 13 |
1 files changed, 8 insertions, 5 deletions
@@ -7,7 +7,7 @@ Below is a copy of this format: === begin example commit === -[tag] Short explanation of the commit +tag: 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 @@ -27,13 +27,14 @@ tracker reference if applicable) and so forth. Be concise but not too brief. - You can prefix the first line with one tag, to make it easier to know to which part of the module the commit applies. For example, a commit with - "[fish] Make it work with newer fortune" in the gnome-panel module clearly + "fish: Make it work with newer fortune" in the gnome-panel module clearly applies to the fish applet. - 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. This main description can be - empty if the change is self-explanatory (eg: "Add DOAP file"). + sent to a mailing list, the body is copied from there. This main + description can be empty if the change is self-explanatory (eg: "Add DOAP + file"). - When committing code on behalf of others use the --author option, e.g. git commit -a --author "Joe Coder <joe@coder.org>". @@ -41,7 +42,9 @@ tracker reference if applicable) and so forth. Be concise but not too brief. - When referring to a bug, you can use this form: bgo#12345. Use bgo for bugzilla.gnome.org, but you can also reference bugs in other bug trackers: rh means bugzilla.redhat.com, bnc means bugzilla.novell.com, lp means - launchpad.net, etc. + launchpad.net, etc. Whenever possible, use the full URL of the bug, though. - When a commit closes a bug, the commit message should contain a line like: Closes: http://bugzilla.gnome.org/show_bug.cgi?id=12345 + or simply: + http://bugzilla.gnome.org/show_bug.cgi?id=12345 |