|
Packit |
4e910c |
=== ChangeLog discontinued ===
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
With the move to git, this module is switching from a ChangeLog file to
|
|
Packit |
4e910c |
relying on commit messages to provide change history. Please write commit
|
|
Packit |
4e910c |
messages in the format described at http://live.gnome.org/Git/CommitMessages
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
Below is a copy of this format:
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
=== begin example commit ===
|
|
Packit |
4e910c |
tag: Short explanation of the commit
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
Longer explanation explaining exactly what's changed, whether any
|
|
Packit |
4e910c |
external or private interfaces changed, what bugs were fixed (with bug
|
|
Packit |
4e910c |
tracker reference if applicable) and so forth. Be concise but not too brief.
|
|
Packit |
4e910c |
=== end example commit ===
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- The commit message is mainly for the other people, so they should be able
|
|
Packit |
4e910c |
to understand it now and six months later.
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- Always add a brief description of the commit to the _first_ line of the
|
|
Packit |
4e910c |
commit and terminate by two newlines (it will work without the second
|
|
Packit |
4e910c |
newline, but that is not nice for the interfaces).
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- First line (the brief description) must only be one sentence and should
|
|
Packit |
4e910c |
start with a capital letter unless it starts with a lowercase symbol or
|
|
Packit |
4e910c |
identifier. Don't use a trailing period either. Don't exceed 72 characters.
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- You can prefix the first line with one tag, to make it easier to know to
|
|
Packit |
4e910c |
which part of the module the commit applies. For example, a commit with
|
|
Packit |
4e910c |
"fish: Make it work with newer fortune" in the gnome-panel module clearly
|
|
Packit |
4e910c |
applies to the fish applet.
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- The main description (the body) is normal prose and should use normal
|
|
Packit |
4e910c |
punctuation and capital letters where appropriate. Normally, for patches
|
|
Packit |
4e910c |
sent to a mailing list, the body is copied from there. This main
|
|
Packit |
4e910c |
description can be empty if the change is self-explanatory (eg: "Add DOAP
|
|
Packit |
4e910c |
file").
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- When committing code on behalf of others use the --author option, e.g. git
|
|
Packit |
4e910c |
commit -a --author "Joe Coder <joe@coder.org>".
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- When referring to a bug, you can use this form: bgo#12345. Use bgo for
|
|
Packit |
4e910c |
bugzilla.gnome.org, but you can also reference bugs in other bug trackers:
|
|
Packit |
4e910c |
rh means bugzilla.redhat.com, bnc means bugzilla.novell.com, lp means
|
|
Packit |
4e910c |
launchpad.net, etc. Whenever possible, use the full URL of the bug, though.
|
|
Packit |
4e910c |
|
|
Packit |
4e910c |
- When a commit closes a bug, the commit message should contain a line like:
|
|
Packit |
4e910c |
Closes: http://bugzilla.gnome.org/show_bug.cgi?id=12345
|
|
Packit |
4e910c |
or simply:
|
|
Packit |
4e910c |
http://bugzilla.gnome.org/show_bug.cgi?id=12345
|