On 24/09/2012 21:57, Marvin Humphrey wrote:
On Fri, Sep 21, 2012 at 2:51 PM, Nick Wellnhofer <[email protected]> wrote:
We should also decide on the commit email subject format. My proposal is

     [$repo/$branch] $subject

I like that better than all of the canned alternatives.  Including the branch
name is a great idea.  :)

So, an email to [email protected] would have a subject something like this:

     [lucy-commits] [lucy/LUCY-215-cf-extensions] Document new params

It bothers me a bit that the most salient info is off on the right where it's
in danger of getting truncated in many situations.

How about we put the $subject earlier, and dispense with $repo?

     $subject [$branch]

Sample:

     [lucy-commits] Document new params [LUCY-215-cf-extensions]

I consider repo and branch more important than the commit message, especially considering a list of commit email subjects:

[lucy-commits] [lucy/master] Move some util modules under Clownfish.
[lucy-commits] [lucy/master] Make CONTRIBUTING Git-centric.
[lucy-commits] [lucy/master] Relax class name restrictions slightly.
[lucy-commits] [lucy/LUCY-215-cf-extensions] Remove obsolete functions.
[lucy-commits] [lucy/LUCY-215-cf-extensions] LUCY-243 Warn when file
[lucy-commits] [lucy/LUCY-215-cf-extensions] Have OS_remove() return
[lucy-commits] [lucy/LUCY-215-cf-extensions] Rename build actions
[lucy-commits] [lucy/master] Add Charmony.pm to cleanup
[lucy-commits] [lucy/master] LUCY-245 Safe Charmonizer file removal
[lucy-commits] [lucy/master] Skip linking when test compiling.
[lucy-commits] [lucy/master] Supply Carp so that a confess() call wi
[lucy-commits] [lucy/master] fix NFS clean up issue reported by frie

Compare this to:

[lucy-commits] Move some util modules under Clownfish. [lucy/master]
[lucy-commits] Make CONTRIBUTING Git-centric. [lucy/master]
[lucy-commits] Relax class name restrictions slightly. [lucy/master]
[lucy-commits] Remove obsolete functions. [lucy/LUCY-215-cf-extensions]
[lucy-commits] LUCY-243 Warn when file [lucy/LUCY-215-cf-extensions]
[lucy-commits] Have OS_remove() return [lucy/LUCY-215-cf-extensions]
[lucy-commits] Rename build actions [lucy/LUCY-215-cf-extensions]
[lucy-commits] Add Charmony.pm to cleanup [lucy/master]
[lucy-commits] LUCY-245 Safe Charmonizer file removal [lucy/master]
[lucy-commits] Skip linking when test compiling. [lucy/master]
[lucy-commits] Supply Carp so that a confess() call wi [lucy/master]
[lucy-commits] fix NFS clean up issue reported by frie [lucy/master]

I find the former much easier to scan. I'm OK with omitting the repo name from the subject as long as we only have a single repo.

Nick

Reply via email to