Re: Moving GLib and GTK+ to git

On Fri, Apr 3, 2009 at 10:04 AM, Edward Hervey <bilboed gmail com> wrote:
> On Tue, 2009-03-31 at 21:29 +0200, Martin Nordholts wrote:
>> Matthias Clasen wrote:
>> >  - First line (the brief description) must only be one sentence and
>> >    must not start with a capital letter. Don't use a trailing period
>> >    either. Don't exceed 76 characters.
>> Hi,
>> Is there any particular reason for not starting with a capital letter,
>> e.g. are there any tools that depend on it? In general I think a
>> sentence look nicer if it starts with a capital letter, including those
>> that does not end with a period. From a quick look at the most recent
>> commit messages for the Linux kernel and git itself, it does not seem as
>> if they have a rule such as the one above, which makes me even more
>> curious why we should have it.
>  FWIW, In GStreamer git repositories we use that same rule for the
> one-liner with a subtle variation:
>  * We do allow capital letters (seriously, who cares? It looks nice)
>  * Considering you want to have as much info as possible in that
> one-liner, we try to prefix it with a word giving a clue as to where the
> work was done (without looking at the modified files). Doesn't apply if
> it's a change accross the whole module.
>  Ex :
>   "rtspsrc: allow http:// on the proxy setting", or
>   "Mark unused arguments using G_GNUC_UNUSED glib macro."

This is also the guideline used in git.git, and it looks pretty good:

id: fix foobar

or if there's no id:

Generic cleanup

Note that no full-stop is used.

Felipe Contreras

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]