You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@beam.apache.org by Jean-Baptiste Onofré <jb...@nanthrax.net> on 2017/05/01 05:39:30 UTC

Re: git commit message

Ah, as the subject of the thread is "git commit message", I thought you talked 
about the commit message.

The commit message should look like "[BEAM-xx] message" for the squashed 
content, and "[BEAM-xx] This closes #yyyy" for the merge commit.

Regarding the pull request title, I highly recommend to use the Jira ID and 
quick abstract of the changes in the PR.

Regards
JB

On 04/30/2017 10:40 PM, Ted Yu wrote:
> I was actually talking about title of the PR.
>
> From the link, there is guideline which some of the recent commits didn't
> follow:
>
> The title of the pull request should be strictly in the following format:
>
>
> On Sun, Apr 30, 2017 at 1:22 PM, Chamikara Jayalath <ch...@apache.org>
> wrote:
>
>> Do we have a convention on the commit message ? Seems like Contributor's
>> guide only talks about the title of the PR not the commit message. I might
>> be missing something.
>>
>> https://beam.apache.org/contribute/contribution-guide/
>> #create-a-pull-request
>>
>> Thanks,
>> Cham
>>
>> On Sun, Apr 30, 2017 at 12:41 PM Jean-Baptiste Onofr� <jb...@nanthrax.net>
>> wrote:
>>
>>> Hi,
>>>
>>> IMHO, it's very rare. That's true we did couple of "fast" commit to fix
>>> issues
>>> (I remember at the beginning of the project).
>>>
>>> However, almost all changes go via PR and most of with a Jira.
>>>
>>> So, if maybe you found couple of, again, it's rare and we follow the
>>> Jira/PR/review/commit path.
>>>
>>> Regards
>>> JB
>>>
>>> On 04/30/2017 04:59 PM, Ted Yu wrote:
>>>> Hi,
>>>> When I went over git commit messages, I found some without either of
>> the
>>>> following:
>>>>
>>>> JIRA number
>>>> PR number
>>>>
>>>> It would be nice for other people to get background / goal / discussion
>>>> w.r.t. any commit if either (or both) of the above is present.
>>>>
>>>> My two cents.
>>>>
>>>
>>> --
>>> Jean-Baptiste Onofr�
>>> jbonofre@apache.org
>>> http://blog.nanthrax.net
>>> Talend - http://www.talend.com
>>>
>>
>

-- 
Jean-Baptiste Onofr�
jbonofre@apache.org
http://blog.nanthrax.net
Talend - http://www.talend.com