ChangeLog 1.17 KB
Newer Older
1
=== ChangeLog discontinued ===
stefw's avatar
stefw committed
2

3
4
5
 With the move to git, seahorse is switching from a ChangeLog 
 file to relying on commit messages to provide change history. Please
 write commit messages in the following format:
stefw's avatar
stefw committed
6

7
=== begin example commit ===
stefw's avatar
stefw committed
8

9
 Short explanation of the commit
Adam Schreiber's avatar
Adam Schreiber committed
10

11
12
13
14
 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.
Adam Schreiber's avatar
Adam Schreiber committed
15

16
=== end example commit ===
17

18
19
20
 - Always add a brief description of the commit to the _first_ line of
 the commit and terminate by two newlines. This may be the title of
 a fixed bug, copied from Bugzilla.
21

22
23
24
25
 - 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 full stop,
 and don't exceed 72 characters.
26

27
28
 - The main description (the body) is normal prose and should use
 normal punctuation and capital letters where appropriate.
29

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