You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hawq.apache.org by Jimmy Da <jd...@cornell.edu> on 2015/09/30 00:31:43 UTC
Commit messages
Not a big deal, just the OCD part of me want to bring this up.
According to
https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ, our
commit message should look like
HAWQ-###*.* Commit message blah blah blah
We use period '.' to separate the JIRA number and the commit message.
I don't quite feel good about the '.', so I looked up a bunch of other
Apache projects and found their separators:
hbase uses just a space
storm, hive, samza uses ":"
I really like the ":" separator as they convey the relationship between the
JIRA number and the message explaining the JIRA number.
Can we change the commit messages to
HAWQ-###: Commit message blah blah blah
Re: Commit messages
Posted by Konstantin Boudnik <co...@apache.org>.
On Wed, Sep 30, 2015 at 01:44AM, Caleb Welton wrote:
> Another related observation. The git commit hooks are setup to automatically
> close The github PRs if your commit message ends in (closes N) where N is
> your PR number - Roman please correct me if I have the syntax wrong.
>
> So when dealing with a commit from github you might use:
>
> HAWQ-1: remove .p4ignore files (closes 2)
I believe these are github hooks you're talking about? I don't believe Apache
git deals with GH PRs closing. Besides, considering that github isn't a
primary VCS of Apache, the info about GH tickets is orthogonal and of small
value. Do you want to pollute the github history with something irrelevant?
Cos
> Then the PR will autoclose.
>
> > On Sep 30, 2015, at 12:31 AM, Jimmy Da <jd...@cornell.edu> wrote:
> >
> > Not a big deal, just the OCD part of me want to bring this up.
> >
> > According to
> > https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ, our
> > commit message should look like
> >
> > HAWQ-###*.* Commit message blah blah blah
> >
> > We use period '.' to separate the JIRA number and the commit message.
> >
> > I don't quite feel good about the '.', so I looked up a bunch of other
> > Apache projects and found their separators:
> > hbase uses just a space
> > storm, hive, samza uses ":"
> >
> > I really like the ":" separator as they convey the relationship between the
> > JIRA number and the message explaining the JIRA number.
> >
> > Can we change the commit messages to
> > HAWQ-###: Commit message blah blah blah
Re: Commit messages
Posted by Caleb Welton <cw...@pivotal.io>.
Hmm, I was just repeating what I heard Roman say after we were discussing
why the git PR was not auto-closed by my commit. Maybe the problem was
that I used 'HAWQ-1:' instead of 'HAWQ-1.', mea culpa for not following the
period standard.
Which makes it more topical to the thread :)
On Wed, Sep 30, 2015 at 3:32 AM, Zhanwei Wang <zw...@pivotal.io> wrote:
> Hi Caleb
>
> The PR will automatically close if HAWQ-XXX is in the commit message.
> "closes N" is not required.
>
>
>
> On Wed, Sep 30, 2015 at 7:44 AM, Caleb Welton <cw...@pivotal.io> wrote:
>
> > Another related observation. The git commit hooks are setup to
> > automatically close The github PRs if your commit message ends in (closes
> > N) where N is your PR number - Roman please correct me if I have the
> syntax
> > wrong.
> >
> > So when dealing with a commit from github you might use:
> >
> > HAWQ-1: remove .p4ignore files (closes 2)
> >
> > Then the PR will autoclose.
> >
> > > On Sep 30, 2015, at 12:31 AM, Jimmy Da <jd...@cornell.edu> wrote:
> > >
> > > Not a big deal, just the OCD part of me want to bring this up.
> > >
> > > According to
> > > https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ,
> > our
> > > commit message should look like
> > >
> > > HAWQ-###*.* Commit message blah blah blah
> > >
> > > We use period '.' to separate the JIRA number and the commit message.
> > >
> > > I don't quite feel good about the '.', so I looked up a bunch of other
> > > Apache projects and found their separators:
> > > hbase uses just a space
> > > storm, hive, samza uses ":"
> > >
> > > I really like the ":" separator as they convey the relationship between
> > the
> > > JIRA number and the message explaining the JIRA number.
> > >
> > > Can we change the commit messages to
> > > HAWQ-###: Commit message blah blah blah
> >
>
>
>
> --
> Best Regards
> ----------
>
> Zhanwei Wang
>
Re: Commit messages
Posted by Roman Shaposhnik <ro...@shaposhnik.org>.
On Wed, Sep 30, 2015 at 4:32 AM, Zhanwei Wang <zw...@pivotal.io> wrote:
> Hi Caleb
>
> The PR will automatically close if HAWQ-XXX is in the commit message.
> "closes N" is not required.
I don't think it does. I think you've got to include the closes part. Here's
the "formal" specification of the syntax:
https://help.github.com/articles/closing-issues-via-commit-messages/
Thanks,
Roman.
Re: Commit messages
Posted by Zhanwei Wang <zw...@pivotal.io>.
Hi Caleb
The PR will automatically close if HAWQ-XXX is in the commit message.
"closes N" is not required.
On Wed, Sep 30, 2015 at 7:44 AM, Caleb Welton <cw...@pivotal.io> wrote:
> Another related observation. The git commit hooks are setup to
> automatically close The github PRs if your commit message ends in (closes
> N) where N is your PR number - Roman please correct me if I have the syntax
> wrong.
>
> So when dealing with a commit from github you might use:
>
> HAWQ-1: remove .p4ignore files (closes 2)
>
> Then the PR will autoclose.
>
> > On Sep 30, 2015, at 12:31 AM, Jimmy Da <jd...@cornell.edu> wrote:
> >
> > Not a big deal, just the OCD part of me want to bring this up.
> >
> > According to
> > https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ,
> our
> > commit message should look like
> >
> > HAWQ-###*.* Commit message blah blah blah
> >
> > We use period '.' to separate the JIRA number and the commit message.
> >
> > I don't quite feel good about the '.', so I looked up a bunch of other
> > Apache projects and found their separators:
> > hbase uses just a space
> > storm, hive, samza uses ":"
> >
> > I really like the ":" separator as they convey the relationship between
> the
> > JIRA number and the message explaining the JIRA number.
> >
> > Can we change the commit messages to
> > HAWQ-###: Commit message blah blah blah
>
--
Best Regards
----------
Zhanwei Wang
Re: Commit messages
Posted by Caleb Welton <cw...@pivotal.io>.
Another related observation. The git commit hooks are setup to automatically close The github PRs if your commit message ends in (closes N) where N is your PR number - Roman please correct me if I have the syntax wrong.
So when dealing with a commit from github you might use:
HAWQ-1: remove .p4ignore files (closes 2)
Then the PR will autoclose.
> On Sep 30, 2015, at 12:31 AM, Jimmy Da <jd...@cornell.edu> wrote:
>
> Not a big deal, just the OCD part of me want to bring this up.
>
> According to
> https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ, our
> commit message should look like
>
> HAWQ-###*.* Commit message blah blah blah
>
> We use period '.' to separate the JIRA number and the commit message.
>
> I don't quite feel good about the '.', so I looked up a bunch of other
> Apache projects and found their separators:
> hbase uses just a space
> storm, hive, samza uses ":"
>
> I really like the ":" separator as they convey the relationship between the
> JIRA number and the message explaining the JIRA number.
>
> Can we change the commit messages to
> HAWQ-###: Commit message blah blah blah
Re: Commit messages
Posted by Jimmy Da <jd...@cornell.edu>.
Good discussion. '.' will do :)
Jimmy Da
Electrical and Computer Engineering
Cornell University 2011
On Tue, Sep 29, 2015 at 11:19 PM, Caleb Welton <cw...@pivotal.io> wrote:
> Makes sense. I'm convinced. Let's keep '.'
>
> > On Sep 30, 2015, at 8:05 AM, CHANG Lei <ch...@gmail.com> wrote:
> >
> > Here is another background for the "." convention when I used that in the
> > proposal:
> >
> > It is the same to core components of hadoop (hdfs and yarn), and
> obviously
> > some more close collaboration between the teams are needed in future, for
> > example some yarn and hdfs related contribution might be from hawq, for
> > example libhdfs3 and libyarn et al
> >
> > Same convention is helpful.
> >
> > Cheers
> > Lei
> >
> >
> >
> >> On Wed, Sep 30, 2015 at 2:22 AM, Konstantin Boudnik <co...@apache.org>
> wrote:
> >>
> >> Very good point. Having a white-space isn't an option as you end up with
> >> more
> >> complex and potentially error-prone filtering if you need process logs
> >> automatically. And colon is aesthetically wrong in this context, IMO.
> '.'
> >> feels
> >> correct.
> >>
> >>> On Tue, Sep 29, 2015 at 03:31PM, Jimmy Da wrote:
> >>> Not a big deal, just the OCD part of me want to bring this up.
> >>>
> >>> According to
> >>> https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ,
> >> our
> >>> commit message should look like
> >>>
> >>> HAWQ-###*.* Commit message blah blah blah
> >>>
> >>> We use period '.' to separate the JIRA number and the commit message.
> >>>
> >>> I don't quite feel good about the '.', so I looked up a bunch of other
> >>> Apache projects and found their separators:
> >>> hbase uses just a space
> >>> storm, hive, samza uses ":"
> >>>
> >>> I really like the ":" separator as they convey the relationship between
> >> the
> >>> JIRA number and the message explaining the JIRA number.
> >>>
> >>> Can we change the commit messages to
> >>> HAWQ-###: Commit message blah blah blah
> >>
>
Re: Commit messages
Posted by Caleb Welton <cw...@pivotal.io>.
Makes sense. I'm convinced. Let's keep '.'
> On Sep 30, 2015, at 8:05 AM, CHANG Lei <ch...@gmail.com> wrote:
>
> Here is another background for the "." convention when I used that in the
> proposal:
>
> It is the same to core components of hadoop (hdfs and yarn), and obviously
> some more close collaboration between the teams are needed in future, for
> example some yarn and hdfs related contribution might be from hawq, for
> example libhdfs3 and libyarn et al
>
> Same convention is helpful.
>
> Cheers
> Lei
>
>
>
>> On Wed, Sep 30, 2015 at 2:22 AM, Konstantin Boudnik <co...@apache.org> wrote:
>>
>> Very good point. Having a white-space isn't an option as you end up with
>> more
>> complex and potentially error-prone filtering if you need process logs
>> automatically. And colon is aesthetically wrong in this context, IMO. '.'
>> feels
>> correct.
>>
>>> On Tue, Sep 29, 2015 at 03:31PM, Jimmy Da wrote:
>>> Not a big deal, just the OCD part of me want to bring this up.
>>>
>>> According to
>>> https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ,
>> our
>>> commit message should look like
>>>
>>> HAWQ-###*.* Commit message blah blah blah
>>>
>>> We use period '.' to separate the JIRA number and the commit message.
>>>
>>> I don't quite feel good about the '.', so I looked up a bunch of other
>>> Apache projects and found their separators:
>>> hbase uses just a space
>>> storm, hive, samza uses ":"
>>>
>>> I really like the ":" separator as they convey the relationship between
>> the
>>> JIRA number and the message explaining the JIRA number.
>>>
>>> Can we change the commit messages to
>>> HAWQ-###: Commit message blah blah blah
>>
Re: Commit messages
Posted by CHANG Lei <ch...@gmail.com>.
Here is another background for the "." convention when I used that in the
proposal:
It is the same to core components of hadoop (hdfs and yarn), and obviously
some more close collaboration between the teams are needed in future, for
example some yarn and hdfs related contribution might be from hawq, for
example libhdfs3 and libyarn et al
Same convention is helpful.
Cheers
Lei
On Wed, Sep 30, 2015 at 2:22 AM, Konstantin Boudnik <co...@apache.org> wrote:
> Very good point. Having a white-space isn't an option as you end up with
> more
> complex and potentially error-prone filtering if you need process logs
> automatically. And colon is aesthetically wrong in this context, IMO. '.'
> feels
> correct.
>
> On Tue, Sep 29, 2015 at 03:31PM, Jimmy Da wrote:
> > Not a big deal, just the OCD part of me want to bring this up.
> >
> > According to
> > https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ,
> our
> > commit message should look like
> >
> > HAWQ-###*.* Commit message blah blah blah
> >
> > We use period '.' to separate the JIRA number and the commit message.
> >
> > I don't quite feel good about the '.', so I looked up a bunch of other
> > Apache projects and found their separators:
> > hbase uses just a space
> > storm, hive, samza uses ":"
> >
> > I really like the ":" separator as they convey the relationship between
> the
> > JIRA number and the message explaining the JIRA number.
> >
> > Can we change the commit messages to
> > HAWQ-###: Commit message blah blah blah
>
Re: Commit messages
Posted by Konstantin Boudnik <co...@apache.org>.
Very good point. Having a white-space isn't an option as you end up with more
complex and potentially error-prone filtering if you need process logs
automatically. And colon is aesthetically wrong in this context, IMO. '.' feels
correct.
On Tue, Sep 29, 2015 at 03:31PM, Jimmy Da wrote:
> Not a big deal, just the OCD part of me want to bring this up.
>
> According to
> https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ, our
> commit message should look like
>
> HAWQ-###*.* Commit message blah blah blah
>
> We use period '.' to separate the JIRA number and the commit message.
>
> I don't quite feel good about the '.', so I looked up a bunch of other
> Apache projects and found their separators:
> hbase uses just a space
> storm, hive, samza uses ":"
>
> I really like the ":" separator as they convey the relationship between the
> JIRA number and the message explaining the JIRA number.
>
> Can we change the commit messages to
> HAWQ-###: Commit message blah blah blah
Re: Commit messages
Posted by Caleb Welton <cw...@pivotal.io>.
+0.1 to Jimmy's suggestion.
> On Sep 30, 2015, at 12:31 AM, Jimmy Da <jd...@cornell.edu> wrote:
>
> Not a big deal, just the OCD part of me want to bring this up.
>
> According to
> https://cwiki.apache.org/confluence/display/HAWQ/Contributing+to+HAWQ, our
> commit message should look like
>
> HAWQ-###*.* Commit message blah blah blah
>
> We use period '.' to separate the JIRA number and the commit message.
>
> I don't quite feel good about the '.', so I looked up a bunch of other
> Apache projects and found their separators:
> hbase uses just a space
> storm, hive, samza uses ":"
>
> I really like the ":" separator as they convey the relationship between the
> JIRA number and the message explaining the JIRA number.
>
> Can we change the commit messages to
> HAWQ-###: Commit message blah blah blah