Blame README.commits

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