| 1 |
=== ChangeLog discontinued === |
| 2 |
|
| 3 |
With the move to git, this module is switching from a ChangeLog file to |
| 4 |
relying on commit messages to provide change history. Please write commit |
| 5 |
messages in the format described at http://live.gnome.org/Git/CommitMessages |
| 6 |
|
| 7 |
Below is a copy of this format: |
| 8 |
|
| 9 |
=== begin example commit === |
| 10 |
tag: Short explanation of the commit |
| 11 |
|
| 12 |
Longer explanation explaining exactly what's changed, whether any |
| 13 |
external or private interfaces changed, what bugs were fixed (with bug |
| 14 |
tracker reference if applicable) and so forth. Be concise but not too brief. |
| 15 |
=== end example commit === |
| 16 |
|
| 17 |
- The commit message is mainly for the other people, so they should be able |
| 18 |
to understand it now and six months later. |
| 19 |
|
| 20 |
- Always add a brief description of the commit to the _first_ line of the |
| 21 |
commit and terminate by two newlines (it will work without the second |
| 22 |
newline, but that is not nice for the interfaces). |
| 23 |
|
| 24 |
- First line (the brief description) must only be one sentence and should |
| 25 |
start with a capital letter unless it starts with a lowercase symbol or |
| 26 |
identifier. Don't use a trailing period either. Don't exceed 72 characters. |
| 27 |
|
| 28 |
- You can prefix the first line with one tag, to make it easier to know to |
| 29 |
which part of the module the commit applies. For example, a commit with |
| 30 |
"fish: Make it work with newer fortune" in the gnome-panel module clearly |
| 31 |
applies to the fish applet. |
| 32 |
|
| 33 |
- The main description (the body) is normal prose and should use normal |
| 34 |
punctuation and capital letters where appropriate. Normally, for patches |
| 35 |
sent to a mailing list, the body is copied from there. This main |
| 36 |
description can be empty if the change is self-explanatory (eg: "Add DOAP |
| 37 |
file"). |
| 38 |
|
| 39 |
- When committing code on behalf of others use the --author option, e.g. git |
| 40 |
commit -a --author "Joe Coder <[email protected]>". |
| 41 |
|
| 42 |
- When referring to a bug, you can use this form: bgo#12345. Use bgo for |
| 43 |
bugzilla.gnome.org, but you can also reference bugs in other bug trackers: |
| 44 |
rh means bugzilla.redhat.com, bnc means bugzilla.novell.com, lp means |
| 45 |
launchpad.net, etc. Whenever possible, use the full URL of the bug, though. |
| 46 |
|
| 47 |
- When a commit closes a bug, the commit message should contain a line like: |
| 48 |
Closes: http://bugzilla.gnome.org/show_bug.cgi?id=12345 |
| 49 |
or simply: |
| 50 |
http://bugzilla.gnome.org/show_bug.cgi?id=12345 |