Blame README.commits

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