ChangeLog 2.33 KB
Newer Older
1
=== ChangeLog discontinued ===
2

3 4
 With the move to git, this module is switching from a ChangeLog file to
 relying on commit messages to provide change history. Please write commit
5 6 7
 messages in the format described at http://live.gnome.org/Git/CommitMessages

 Below is a copy of this format:
8

9
=== begin example commit ===
10
tag: Short explanation of the commit
11

12 13 14 15
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 ===
Vincent Untz's avatar
Vincent Untz committed
16

17 18 19 20 21 22 23 24 25 26
  - The commit message is mainly for the other people, so they should be able
    to understand it now and six months later. 

  - Always add a brief description of the commit to the _first_ line of the
    commit and terminate by two newlines (it will work without the second
    newline, but that is not nice for the interfaces).

  - 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 period either. Don't exceed 72 characters.
Vincent Untz's avatar
Vincent Untz committed
27

28 29
  - 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
30
    "fish: Make it work with newer fortune" in the gnome-panel module clearly
31
    applies to the fish applet.
32

33 34
  - The main description (the body) is normal prose and should use normal
    punctuation and capital letters where appropriate. Normally, for patches
35 36 37
    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").
38 39 40 41

  - When committing code on behalf of others use the --author option, e.g. git
    commit -a --author "Joe Coder <joe@coder.org>".

42
  - When referring to a bug, you can use this form: bgo#12345. Use bgo for
43 44
    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
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 50
    or simply:
    http://bugzilla.gnome.org/show_bug.cgi?id=12345