|
Packit |
b00eeb |
=== ChangeLog discontinued ===
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
gcr does not use a manually edited ChangeLog file. We rely on commit
|
|
Packit |
b00eeb |
messages to provide change history. Please write commit messages
|
|
Packit |
b00eeb |
in the following format:
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
=== begin example commit ===
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
Short explanation of the commit
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
Longer explanation explaining exactly what's changed, whether any
|
|
Packit |
b00eeb |
external or private interfaces changed, what bugs were fixed (with bug
|
|
Packit |
b00eeb |
tracker reference if applicable) and so forth. Be concise but not too
|
|
Packit |
b00eeb |
brief.
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
=== end example commit ===
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
- Always add a brief description of the commit to the _first_ line of
|
|
Packit |
b00eeb |
the commit and terminate by two newlines. This may be the title of
|
|
Packit |
b00eeb |
a fixed bug, copied from Bugzilla.
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
- First line (the brief description) must only be one sentence and
|
|
Packit |
b00eeb |
should start with a capital letter unless it starts with a
|
|
Packit |
b00eeb |
lowercase symbol or identifier. Don't use a trailing full stop,
|
|
Packit |
b00eeb |
and don't exceed 72 characters.
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
- The main description (the body) is normal prose and should use
|
|
Packit |
b00eeb |
normal punctuation and capital letters where appropriate.
|
|
Packit |
b00eeb |
|
|
Packit |
b00eeb |
- When committing code on behalf of others use the --author option,
|
|
Packit |
b00eeb |
e.g. git commit -a --author "Joe Coder <joe@coder.org>" and
|
|
Packit |
b00eeb |
--signoff.
|
|
Packit |
b00eeb |
|