README.commits

   1 Atk is part of the GNOME git repository. With git, we no longer
   2 maintain a ChangeLog file, but you are expected to produce a meaningful
   3 commit message. Changes without a sufficient commit message will be
   4 reverted. The expected format for git commit messages is as follows:
   5
   6 === begin example commit ===
   7 Short explanation of the commit
   8
   9 Longer explanation explaining exactly what's changed, whether any
  10 external or private interfaces changed, what bugs were fixed (with bug
  11 tracker reference if applicable) and so forth. Be concise but not too brief.
  12 === end example commit ===
  13
  14   - Always add a brief description of the commit to the _first_ line of
  15     the commit and terminate by two newlines (it will work without the
  16     second newline, but that is not nice for the interfaces).
  17
  18   - First line (the brief description) must only be one sentence and
  19     should start with a capital letter unless it starts with a lowercase
  20     symbol or identifier. Don't use a trailing period either. Don't exceed
  21     72 characters.
  22
  23   - The main description (the body) is normal prose and should use normal
  24     punctuation and capital letters where appropriate. Normally, for patches
  25     sent to a mailing list it's copied from there.
  26
  27   - When committing code on behalf of others use the --author option, e.g.
  28     git commit -a --author "Joe Coder <joe@coder.org>" and --signoff.
  29