git commit message conventions

[Carlos O'Donell]

On 06/03/2015 10:08 AM, Joseph Myers wrote:
> On Wed, 3 Jun 2015, Carlos O'Donell wrote:
> 
>> I think your proposal is great, but we already require this?
>>
>> https://sourceware.org/glibc/wiki/Committer%20checklist#Create_a_Proper_Commit_Message
>>
>> https://sourceware.org/glibc/wiki/GlibcGit#Commit_Messages
>>
>> Do we need to remind people to follow the Committer Checklist?
> 
> Maybe we do.  I see lots of commits with only a single line although 
> there's a more substantial description on libc-alpha (commits to master, 
> that is; what people do on their own branches is up to them).  I see quite 
> a few where people fail to use --author when committing for other people.  
> I see the occasional commit where the first line isn't a useful patch 
> description at all, but is either the author line from the ChangeLog 
> entry, or the first content line from the ChangeLog entry (possibly a line 
> just saying [BZ #N]).

I've done the following for the Committer Checklist:

(1) Added explicit language about the commit message format, noted
    that open bug numbers should be present in a commit message that
    fixes the bug, and referenced GlibcGit wiki page.

(2) Mention that we use auto-annotate for bugzilla from git pushes
    and that if you write your commit message correctly you need only
    close out the issue.

    Modulo RFE bug 13746 everything is working OK with auto-annotate.

>> Do we need to update the Contribution Checklist to remind people
>> that their email will become the commit message?
> 
> That seems sensible as well.

I've done the following for the Contribution Checklist:

(1) Under "Contribution Email Subject Line" added:

"Your contribution email subject line will become the first line
 of the commit message for your patch."

(2) Under "Detailed explanation of the patch" added:

"The detailed explanation will become the body of the commit 
message for your patch. Please keep this in mind and format 
accordingly or indicate to the reviewer which part of the 
email should be the body of the commit message."

Cheers,
Carlos.