Blame README.commits

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