Blame README.commits

Packit ae235b
GLib is part of the GNOME git repository. At the current time, any
Packit ae235b
person with write access to the GNOME repository, can make changes to
Packit ae235b
GLib. This is a good thing, in that it encourages many people to work
Packit ae235b
on GLib, and progress can be made quickly. However, GLib is a fairly
Packit ae235b
large and complicated package that many other things depend on, so to
Packit ae235b
avoid unnecessary breakage, and to take advantage of the knowledge
Packit ae235b
about GLib that has been built up over the years, we'd like to ask
Packit ae235b
people committing to GLib to follow a few rules:
Packit ae235b
Packit ae235b
0) Ask first. If your changes are major, or could possibly break existing
Packit ae235b
   code, you should always ask. If your change is minor and you've
Packit ae235b
   been working on GLib for a while it probably isn't necessary
Packit ae235b
   to ask. But when in doubt, ask. Even if your change is correct,
Packit ae235b
   somebody may know a better way to do things.
Packit ae235b
Packit ae235b
   If you are making changes to GLib, you should be subscribed
Packit ae235b
   to gtk-devel-list@gnome.org. (Subscription address:
Packit ae235b
   gtk-devel-list-request@gnome.org.) This is a good place to ask
Packit ae235b
   about intended changes.
Packit ae235b
Packit ae235b
   #gtk+ on GIMPNet (irc.gimp.org, irc.us.gimp.org, irc.eu.gimp.org, ...)
Packit ae235b
   is also a good place to find GTK+ developers to discuss changes with,
Packit ae235b
   however, email to gtk-devel-list is the most certain and preferred
Packit ae235b
   method.
Packit ae235b
Packit ae235b
1) Ask _first_.
Packit ae235b
Packit ae235b
2) With git, we no longer maintain a ChangeLog file, but you are expected
Packit ae235b
   to produce a meaningful commit message. Changes without a sufficient
Packit ae235b
   commit message will be reverted. See below for the expected format
Packit ae235b
   of commit messages.
Packit ae235b
Packit ae235b
Notes:
Packit ae235b
Packit ae235b
* When developing larger features or complicated bug fixes, it is
Packit ae235b
  advisable to work in a branch in your own cloned GLib repository.
Packit ae235b
  You may even consider making your repository publically available
Packit ae235b
  so that others can easily test and review your changes.
Packit ae235b
Packit ae235b
* The expected format for git commit messages is as follows:
Packit ae235b
Packit ae235b
=== begin example commit ===
Packit ae235b
Short explanation of the commit
Packit ae235b
Packit ae235b
Longer explanation explaining exactly what's changed, whether any
Packit ae235b
external or private interfaces changed, what bugs were fixed (with bug
Packit ae235b
tracker reference if applicable) and so forth. Be concise but not too brief.
Packit ae235b
=== end example commit ===
Packit ae235b
Packit ae235b
  - Always add a brief description of the commit to the _first_ line of
Packit ae235b
    the commit and terminate by two newlines (it will work without the
Packit ae235b
    second newline, but that is not nice for the interfaces).
Packit ae235b
Packit ae235b
  - First line (the brief description) must only be one sentence and
Packit ae235b
    should start with a capital letter unless it starts with a lowercase
Packit ae235b
    symbol or identifier. Don't use a trailing period either. Don't exceed
Packit ae235b
    72 characters.
Packit ae235b
Packit ae235b
  - The main description (the body) is normal prose and should use normal
Packit ae235b
    punctuation and capital letters where appropriate. Normally, for patches
Packit ae235b
    sent to a mailing list it's copied from there.
Packit ae235b
Packit ae235b
  - When committing code on behalf of others use the --author option, e.g.
Packit ae235b
    git commit -a --author "Joe Coder <joe@coder.org>" and --signoff.
Packit ae235b
Packit ae235b
Packit ae235b
Owen Taylor
Packit ae235b
13 Aug 1998
Packit ae235b
17 Apr 2001
Packit ae235b
Packit ae235b
Matthias Clasen
Packit ae235b
31 Mar 2009