You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@phoenix.apache.org by lars hofhansl <la...@apache.org> on 2014/02/04 06:11:51 UTC
Commit messages
In HBase we have commit message of the following form:
HBASE-<number> <message>. (<contributor)
Should we do the same for Phoenix?
For example I just pushed PHOENIX-13. The commit message looked like this:
"PHOENIX-13 Provide a nocache hint to a query. (LarsH)"
That way we can easily find the jira for a commit, and also find a commit by looking in the commit log for the jira number.
Also, I noticed that many (all?) files have @author tags. In HBase we avoid those (there's even a precommit test that flags @author tags as error). I am not sure whether this is an Apache or merely an HBase policy. It seems for a community project it is a good policy.
Comments?
-- Lars
Re: Commit messages
Posted by James Taylor <ja...@apache.org>.
FYI, we have default Eclipse settings in the dev directory.
On Mon, Feb 3, 2014 at 9:50 PM, lars hofhansl <la...@apache.org> wrote:
> I thought so... Too lazy to Google. :)
>
> So if we agree, do we just remove @author tags when we change a file
> anyway, or make an effort and make a big patch?
>
> Lastly. Any formatter preferences. I assume we do not want to tabs anyway,
> but just spaces.
> In HBase we use 2 spaces for indentation in Phoenix we use 4. Either seems
> fine to me.
> Everybody agree with no-tabs? 4 spaces is good? Any other formatting
> preferences?
>
> Could make a default Eclipse formatter (we have that for HBase as well).
>
> -- Lars
>
>
>
> ________________________________
> From: Stack <st...@duboce.net>
> To: dev@phoenix.incubator.apache.org; lars hofhansl <la...@apache.org>
> Sent: Monday, February 3, 2014 9:20 PM
> Subject: Re: Commit messages
>
>
>
> On Mon, Feb 3, 2014 at 9:11 PM, lars hofhansl <la...@apache.org> wrote:
>
> In HBase we have commit message of the following form:
> >HBASE-<number> <message>. (<contributor)
> >
> >Should we do the same for Phoenix?
> >For example I just pushed PHOENIX-13. The commit message looked like this:
> >"PHOENIX-13 Provide a nocache hint to a query. (LarsH)"
> >
> >That way we can easily find the jira for a commit, and also find a commit
> by looking in the commit log for the jira number.
> >
> >Also, I noticed that many (all?) files have @author tags. In HBase we
> avoid those (there's even a precommit test that flags @author tags as
> error). I am not sure whether this is an Apache or merely an HBase policy.
> It seems for a community project it is a good policy.
> >
>
> Removing '@author' tags is an old Apache ruling (Do a bit of googling on
> it).
> St.Ack
>
Re: Commit messages
Posted by lars hofhansl <la...@apache.org>.
I thought so... Too lazy to Google. :)
So if we agree, do we just remove @author tags when we change a file anyway, or make an effort and make a big patch?
Lastly. Any formatter preferences. I assume we do not want to tabs anyway, but just spaces.
In HBase we use 2 spaces for indentation in Phoenix we use 4. Either seems fine to me.
Everybody agree with no-tabs? 4 spaces is good? Any other formatting preferences?
Could make a default Eclipse formatter (we have that for HBase as well).
-- Lars
________________________________
From: Stack <st...@duboce.net>
To: dev@phoenix.incubator.apache.org; lars hofhansl <la...@apache.org>
Sent: Monday, February 3, 2014 9:20 PM
Subject: Re: Commit messages
On Mon, Feb 3, 2014 at 9:11 PM, lars hofhansl <la...@apache.org> wrote:
In HBase we have commit message of the following form:
>HBASE-<number> <message>. (<contributor)
>
>Should we do the same for Phoenix?
>For example I just pushed PHOENIX-13. The commit message looked like this:
>"PHOENIX-13 Provide a nocache hint to a query. (LarsH)"
>
>That way we can easily find the jira for a commit, and also find a commit by looking in the commit log for the jira number.
>
>Also, I noticed that many (all?) files have @author tags. In HBase we avoid those (there's even a precommit test that flags @author tags as error). I am not sure whether this is an Apache or merely an HBase policy. It seems for a community project it is a good policy.
>
Removing '@author' tags is an old Apache ruling (Do a bit of googling on it).
St.Ack
Re: Commit messages
Posted by Stack <st...@duboce.net>.
On Mon, Feb 3, 2014 at 9:11 PM, lars hofhansl <la...@apache.org> wrote:
> In HBase we have commit message of the following form:
> HBASE-<number> <message>. (<contributor)
>
> Should we do the same for Phoenix?
> For example I just pushed PHOENIX-13. The commit message looked like this:
> "PHOENIX-13 Provide a nocache hint to a query. (LarsH)"
>
> That way we can easily find the jira for a commit, and also find a commit
> by looking in the commit log for the jira number.
>
> Also, I noticed that many (all?) files have @author tags. In HBase we
> avoid those (there's even a precommit test that flags @author tags as
> error). I am not sure whether this is an Apache or merely an HBase policy.
> It seems for a community project it is a good policy.
>
Removing '@author' tags is an old Apache ruling (Do a bit of googling on
it).
St.Ack
Re: Commit messages
Posted by Anoop John <an...@gmail.com>.
+1 for the commit message what LarsH proposed. Also if the committer only
is the contributor of the patch can avoid the contributor name also. Not a
big deal that is.
+1 for removing the @author
-Anoop-
On Tue, Feb 4, 2014 at 10:57 AM, Vasudevan, Ramkrishna S <
ramkrishna.s.vasudevan@intel.com> wrote:
> I also noted that there are some copyright information specifying the year
> as 2010. Is this intentional? I think in HBase we removed it. If we need
> this in Phoenix we need to change the year to 2014 or something?
>
> Regards
> Ram
>
> -----Original Message-----
> From: lars hofhansl [mailto:larsh@apache.org]
> Sent: Tuesday, February 04, 2014 10:42 AM
> To: dev@phoenix.incubator.apache.org
> Subject: Commit messages
>
> In HBase we have commit message of the following form:
> HBASE-<number> <message>. (<contributor)
>
> Should we do the same for Phoenix?
> For example I just pushed PHOENIX-13. The commit message looked like this:
> "PHOENIX-13 Provide a nocache hint to a query. (LarsH)"
>
> That way we can easily find the jira for a commit, and also find a commit
> by looking in the commit log for the jira number.
>
> Also, I noticed that many (all?) files have @author tags. In HBase we
> avoid those (there's even a precommit test that flags @author tags as
> error). I am not sure whether this is an Apache or merely an HBase policy.
> It seems for a community project it is a good policy.
>
>
> Comments?
>
> -- Lars
>
>
RE: Commit messages
Posted by "Vasudevan, Ramkrishna S" <ra...@intel.com>.
I also noted that there are some copyright information specifying the year as 2010. Is this intentional? I think in HBase we removed it. If we need this in Phoenix we need to change the year to 2014 or something?
Regards
Ram
-----Original Message-----
From: lars hofhansl [mailto:larsh@apache.org]
Sent: Tuesday, February 04, 2014 10:42 AM
To: dev@phoenix.incubator.apache.org
Subject: Commit messages
In HBase we have commit message of the following form:
HBASE-<number> <message>. (<contributor)
Should we do the same for Phoenix?
For example I just pushed PHOENIX-13. The commit message looked like this:
"PHOENIX-13 Provide a nocache hint to a query. (LarsH)"
That way we can easily find the jira for a commit, and also find a commit by looking in the commit log for the jira number.
Also, I noticed that many (all?) files have @author tags. In HBase we avoid those (there's even a precommit test that flags @author tags as error). I am not sure whether this is an Apache or merely an HBase policy. It seems for a community project it is a good policy.
Comments?
-- Lars