[plt-dev] One e-mail per commit?

From: Jon Rafkind (rafkind at cs.utah.edu)
Date: Tue May 18 16:47:44 EDT 2010

On 05/17/2010 03:49 PM, Ryan Culpepper wrote:
> On 05/17/2010 11:36 AM, Eli Barzilay wrote:
>> On May 17, Ryan Culpepper wrote:
>>>
>>> My ideal form of notification would tell me the committer(s), the
>>> part(s) of the tree where activity was taking place, the commit
>>> messages, and a link to the full diff if I want to examine
>>> it.... all in the first twenty or so lines of the message. (<  20
>>> lines for a typical push; pushes with many commits would need more
>>> lines, of course). I'm disinclined to scroll through long
>>> auto-generated emails, so I probably only catch the first commit
>>> message in the current format.
>>
>> The emails should be pretty minimal in length now -- if you remember,
>> I started with a summary of files changed, but that made it impossible
>> to know what a commit refers to.  At some point in the future I think
>> that I can add some "alert" lines if someone else committed changes to
>> files that you're responsible for.
>
> As an example, the commit summaries in the email for push 20251 don't 
> fit in my message window. There are three commits, and only the first 
> two fit. The list of all files changed takes up a lot of space. How 
> about replacing the list with the closest common ancestor? Here's a 
> mockup:
>
>   samth has updated `master' from b7a20594ef to 0d1d61c725.
>     http://git.racket-lang.org/plt/b7a20594ef..0d1d61c725
>
>   =====[ 3 Commits ]===================================================
>
>   ce874bb Sam Tobin-Hochstadt <samth at racket-lang.org> 2010-05-17 11:24
>     in collects/tests/typed-scheme/succeed/... (7 files)
>   | rename to rkt
>
>   68391b2 Sam Tobin-Hochstadt <samth at racket-lang.org> 2010-05-17 15:36
>     in collects/tests/typed-scheme/succeed/foldo.scm
>   | Fix for git/rkt
>
>   0d1d61c Sam Tobin-Hochstadt <samth at racket-lang.org> 2010-05-17 15:37
>     in collects/tests/typed-scheme/succeed/... (2 files)
>   | rename to .rkt
>
> In this format, I can see all the summaries at a glance and conclude 
> that the push just consists of a bunch of administrative changes in 
> files that I'm not particularly interested in.

+1.

I was interested in a recent commit by Ryan but I ended up ignoring the 
commit email that was sent because the first message was related to 
'racunit' and not 'syntax-parse'. I didn't learn that he had committed 
until I talked to him a day later, and that was sort of lucky as I was 
prepared to wait for longer.

I prefer consolidating the commit messages towards the top of the commit 
email.


Posted on the dev mailing list.