Blame README.commits

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