You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@echarts.apache.org by Ovilia <ov...@gmail.com> on 2019/08/30 09:56:01 UTC

[DISCUSS] Git message guidelines

Currently, we do not have a standard for git message guidelines, so the
commit logs may look a little untidy [1].

A very popular commit guideline is from Angular.js [2], which I think is
very nice only that it includes issue number at the footer.
For example, with Angular.js's commit guideline, a commit message may be:
fix(svg): change the default behavior of download image with toolbox
fix #12345

I think putting the issue number at the end of the subject may be a better
idea.
Because if the issue number is not included in the first line, it will only
be visible when "..." is clicked.
Issue number, and more importantly, the link to the issue is a very
important part of a git message.
[image: commit message.png]

My suggest is, to follow the Angular.js git message guidelines, and change
about the issue number part, making it something like:

fix(svg): change the default behavior of download image with toolbox; fix
#12345


[1] https://github.com/apache/incubator-echarts/commits/master
[2]
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines

Wenli

Re: [DISCUSS] Git message guidelines

Posted by Ovilia <ov...@gmail.com>.
Yes, we would be appreciate such automatic tools only if it doesn't bring
much trouble to contributors.

If a commit message is not following the guidelines, the bot will comment
in the PR and ask the contributor to change the commit message. What
happens if the contributor doesn't change it for a long time?

Wenli


On Thu, Sep 5, 2019 at 10:19 AM Clement Ho <cl...@gitlab.com.invalid>
wrote:

> Actually you’d be surprised we have quite a number of community
> contributors and it’s growing each month.
>
> My concern is that adding these extra layers for the reviewer can make
> maintaining this project more tedious. As a maintainer for GitLab’s
> frontend code, I would highly recommend automating some of these things as
> it is easy to get a lot of PRs to review once the community picks up
> because majority contributors tend to miss these smaller details when
> contributing PRs.
>
> On Wed, Sep 4, 2019 at 9:15 PM Ovilia <ov...@gmail.com> wrote:
>
> > Hi Clement,
> >
> > Thanks for sharing information with us.
> > I suppose most of the committers in your projects at gitlab are all
> > employees so that there won't be a problem with frustrating community
> > contributors with compulsory changes when CI fails.
> > But this could be a problem for us, especially when we wish to encourage
> > more people to contribute.
> >
> > So I'd suggest our committers follow the guidelines, and make this
> > guideline informed to the community but do nothing compulsorily. We can
> > change the commit message when merging the PR in.
> >
> > Wenli
> >
> >
> > On Thu, Sep 5, 2019 at 8:48 AM Clement Ho <cl...@gitlab.com.invalid>
> > wrote:
> >
> > > We use danger bot at gitlab. It comments on the MR/PR and also fails
> the
> > > pipeline when something about the MR/PR is incomplete/incorrect
> > >
> > > On Tue, Sep 3, 2019 at 10:05 PM Ovilia <ov...@gmail.com> wrote:
> > >
> > > > Hi Clement,
> > > >
> > > > What's the process if we add this in CI?
> > > >
> > > > I was considering making these guidelines not compulsory for the
> > > community
> > > > to avoid the roundtrips as you mentioned, and the commit message can
> be
> > > > updated by who approved the pull request in the squashing stage.
> > > >
> > > > Wenli
> > > >
> > > >
> > > > On Wed, Sep 4, 2019 at 8:45 AM Clement Ho <clement@gitlab.com.invalid
> >
> > > > wrote:
> > > >
> > > > > I'm also concerned that this may create more roundtrips during code
> > > > reviews
> > > > > from the community (if we don't automate parts of it)
> > > > >
> > > > > On Tue, Sep 3, 2019 at 7:43 PM Willem Jiang <
> willem.jiang@gmail.com>
> > > > > wrote:
> > > > >
> > > > > > I think providing the fix issue id is quite important for the
> > others
> > > > > > who want to dig the code.
> > > > > > The issue id could link to the discussion or some doc explain why
> > we
> > > > > > do this kind of change.
> > > > > > It's good practice to share the development context across the
> > > > community.
> > > > > >
> > > > > > It could be a pain for the first contributor to submit his first
> > PR,
> > > > > > but with the guide document will reduce that pain.
> > > > > >
> > > > > > Just my 2 cents.
> > > > > >
> > > > > > Willem Jiang
> > > > > >
> > > > > > Twitter: willemjiang
> > > > > > Weibo: 姜宁willem
> > > > > >
> > > > > > On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <
> wu.sheng.841108@gmail.com
> > >
> > > > > wrote:
> > > > > > >
> > > > > > > Hi
> > > > > > >
> > > > > > > This kind of requirement should come from a high diversity and
> > very
> > > > > > active
> > > > > > > community, like the example your using.
> > > > > > > The only reason the commit log important, is because of quick
> > > review
> > > > > > update
> > > > > > > and revert in some critical case.
> > > > > > >
> > > > > > > From the commit log today, there is not that case.
> > > > > > > https://github.com/apache/incubator-echarts/commits/master
> > > > > > >
> > > > > > > I am supporting commit id as better as possible, but also, PPMC
> > > > please
> > > > > > > consider Justin's question/concern, don't make a higher bar
> than
> > > > > before.
> > > > > > >
> > > > > > > Sheng Wu 吴晟
> > > > > > >
> > > > > > > Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> > > > > > > Twitter, wusheng1108
> > > > > > >
> > > > > > >
> > > > > > > Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
> > > > > > >
> > > > > > > > Hi,
> > > > > > > > Just out of interest what is the problem you're trying to
> solve
> > > > here?
> > > > > > It
> > > > > > > > seem to me that doing something like this will make it harder
> > for
> > > > > > users to
> > > > > > > > contribute, when you want to make it easier for them to do
> so.
> > > > > > > > Thanks,
> > > > > > > > Justin
> > > > > > > >
> > > > > > > >
> > > > ---------------------------------------------------------------------
> > > > > > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > > > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > > > > > >
> > > > > > > >
> > > > > >
> > > > > >
> > ---------------------------------------------------------------------
> > > > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > > > >
> > > > > >
> > > > >
> > > >
> > >
> >
>

Re: [DISCUSS] Git message guidelines

Posted by Clement Ho <cl...@gitlab.com.INVALID>.
Actually you’d be surprised we have quite a number of community
contributors and it’s growing each month.

My concern is that adding these extra layers for the reviewer can make
maintaining this project more tedious. As a maintainer for GitLab’s
frontend code, I would highly recommend automating some of these things as
it is easy to get a lot of PRs to review once the community picks up
because majority contributors tend to miss these smaller details when
contributing PRs.

On Wed, Sep 4, 2019 at 9:15 PM Ovilia <ov...@gmail.com> wrote:

> Hi Clement,
>
> Thanks for sharing information with us.
> I suppose most of the committers in your projects at gitlab are all
> employees so that there won't be a problem with frustrating community
> contributors with compulsory changes when CI fails.
> But this could be a problem for us, especially when we wish to encourage
> more people to contribute.
>
> So I'd suggest our committers follow the guidelines, and make this
> guideline informed to the community but do nothing compulsorily. We can
> change the commit message when merging the PR in.
>
> Wenli
>
>
> On Thu, Sep 5, 2019 at 8:48 AM Clement Ho <cl...@gitlab.com.invalid>
> wrote:
>
> > We use danger bot at gitlab. It comments on the MR/PR and also fails the
> > pipeline when something about the MR/PR is incomplete/incorrect
> >
> > On Tue, Sep 3, 2019 at 10:05 PM Ovilia <ov...@gmail.com> wrote:
> >
> > > Hi Clement,
> > >
> > > What's the process if we add this in CI?
> > >
> > > I was considering making these guidelines not compulsory for the
> > community
> > > to avoid the roundtrips as you mentioned, and the commit message can be
> > > updated by who approved the pull request in the squashing stage.
> > >
> > > Wenli
> > >
> > >
> > > On Wed, Sep 4, 2019 at 8:45 AM Clement Ho <cl...@gitlab.com.invalid>
> > > wrote:
> > >
> > > > I'm also concerned that this may create more roundtrips during code
> > > reviews
> > > > from the community (if we don't automate parts of it)
> > > >
> > > > On Tue, Sep 3, 2019 at 7:43 PM Willem Jiang <wi...@gmail.com>
> > > > wrote:
> > > >
> > > > > I think providing the fix issue id is quite important for the
> others
> > > > > who want to dig the code.
> > > > > The issue id could link to the discussion or some doc explain why
> we
> > > > > do this kind of change.
> > > > > It's good practice to share the development context across the
> > > community.
> > > > >
> > > > > It could be a pain for the first contributor to submit his first
> PR,
> > > > > but with the guide document will reduce that pain.
> > > > >
> > > > > Just my 2 cents.
> > > > >
> > > > > Willem Jiang
> > > > >
> > > > > Twitter: willemjiang
> > > > > Weibo: 姜宁willem
> > > > >
> > > > > On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <wu.sheng.841108@gmail.com
> >
> > > > wrote:
> > > > > >
> > > > > > Hi
> > > > > >
> > > > > > This kind of requirement should come from a high diversity and
> very
> > > > > active
> > > > > > community, like the example your using.
> > > > > > The only reason the commit log important, is because of quick
> > review
> > > > > update
> > > > > > and revert in some critical case.
> > > > > >
> > > > > > From the commit log today, there is not that case.
> > > > > > https://github.com/apache/incubator-echarts/commits/master
> > > > > >
> > > > > > I am supporting commit id as better as possible, but also, PPMC
> > > please
> > > > > > consider Justin's question/concern, don't make a higher bar than
> > > > before.
> > > > > >
> > > > > > Sheng Wu 吴晟
> > > > > >
> > > > > > Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> > > > > > Twitter, wusheng1108
> > > > > >
> > > > > >
> > > > > > Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
> > > > > >
> > > > > > > Hi,
> > > > > > > Just out of interest what is the problem you're trying to solve
> > > here?
> > > > > It
> > > > > > > seem to me that doing something like this will make it harder
> for
> > > > > users to
> > > > > > > contribute, when you want to make it easier for them to do so.
> > > > > > > Thanks,
> > > > > > > Justin
> > > > > > >
> > > > > > >
> > > ---------------------------------------------------------------------
> > > > > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > > > > >
> > > > > > >
> > > > >
> > > > >
> ---------------------------------------------------------------------
> > > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > > >
> > > > >
> > > >
> > >
> >
>

Re: [DISCUSS] Git message guidelines

Posted by Ovilia <ov...@gmail.com>.
Hi Clement,

Thanks for sharing information with us.
I suppose most of the committers in your projects at gitlab are all
employees so that there won't be a problem with frustrating community
contributors with compulsory changes when CI fails.
But this could be a problem for us, especially when we wish to encourage
more people to contribute.

So I'd suggest our committers follow the guidelines, and make this
guideline informed to the community but do nothing compulsorily. We can
change the commit message when merging the PR in.

Wenli


On Thu, Sep 5, 2019 at 8:48 AM Clement Ho <cl...@gitlab.com.invalid>
wrote:

> We use danger bot at gitlab. It comments on the MR/PR and also fails the
> pipeline when something about the MR/PR is incomplete/incorrect
>
> On Tue, Sep 3, 2019 at 10:05 PM Ovilia <ov...@gmail.com> wrote:
>
> > Hi Clement,
> >
> > What's the process if we add this in CI?
> >
> > I was considering making these guidelines not compulsory for the
> community
> > to avoid the roundtrips as you mentioned, and the commit message can be
> > updated by who approved the pull request in the squashing stage.
> >
> > Wenli
> >
> >
> > On Wed, Sep 4, 2019 at 8:45 AM Clement Ho <cl...@gitlab.com.invalid>
> > wrote:
> >
> > > I'm also concerned that this may create more roundtrips during code
> > reviews
> > > from the community (if we don't automate parts of it)
> > >
> > > On Tue, Sep 3, 2019 at 7:43 PM Willem Jiang <wi...@gmail.com>
> > > wrote:
> > >
> > > > I think providing the fix issue id is quite important for the others
> > > > who want to dig the code.
> > > > The issue id could link to the discussion or some doc explain why we
> > > > do this kind of change.
> > > > It's good practice to share the development context across the
> > community.
> > > >
> > > > It could be a pain for the first contributor to submit his first PR,
> > > > but with the guide document will reduce that pain.
> > > >
> > > > Just my 2 cents.
> > > >
> > > > Willem Jiang
> > > >
> > > > Twitter: willemjiang
> > > > Weibo: 姜宁willem
> > > >
> > > > On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <wu...@gmail.com>
> > > wrote:
> > > > >
> > > > > Hi
> > > > >
> > > > > This kind of requirement should come from a high diversity and very
> > > > active
> > > > > community, like the example your using.
> > > > > The only reason the commit log important, is because of quick
> review
> > > > update
> > > > > and revert in some critical case.
> > > > >
> > > > > From the commit log today, there is not that case.
> > > > > https://github.com/apache/incubator-echarts/commits/master
> > > > >
> > > > > I am supporting commit id as better as possible, but also, PPMC
> > please
> > > > > consider Justin's question/concern, don't make a higher bar than
> > > before.
> > > > >
> > > > > Sheng Wu 吴晟
> > > > >
> > > > > Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> > > > > Twitter, wusheng1108
> > > > >
> > > > >
> > > > > Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
> > > > >
> > > > > > Hi,
> > > > > > Just out of interest what is the problem you're trying to solve
> > here?
> > > > It
> > > > > > seem to me that doing something like this will make it harder for
> > > > users to
> > > > > > contribute, when you want to make it easier for them to do so.
> > > > > > Thanks,
> > > > > > Justin
> > > > > >
> > > > > >
> > ---------------------------------------------------------------------
> > > > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > > > >
> > > > > >
> > > >
> > > > ---------------------------------------------------------------------
> > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > >
> > > >
> > >
> >
>

Re: [DISCUSS] Git message guidelines

Posted by Clement Ho <cl...@gitlab.com.INVALID>.
We use danger bot at gitlab. It comments on the MR/PR and also fails the
pipeline when something about the MR/PR is incomplete/incorrect

On Tue, Sep 3, 2019 at 10:05 PM Ovilia <ov...@gmail.com> wrote:

> Hi Clement,
>
> What's the process if we add this in CI?
>
> I was considering making these guidelines not compulsory for the community
> to avoid the roundtrips as you mentioned, and the commit message can be
> updated by who approved the pull request in the squashing stage.
>
> Wenli
>
>
> On Wed, Sep 4, 2019 at 8:45 AM Clement Ho <cl...@gitlab.com.invalid>
> wrote:
>
> > I'm also concerned that this may create more roundtrips during code
> reviews
> > from the community (if we don't automate parts of it)
> >
> > On Tue, Sep 3, 2019 at 7:43 PM Willem Jiang <wi...@gmail.com>
> > wrote:
> >
> > > I think providing the fix issue id is quite important for the others
> > > who want to dig the code.
> > > The issue id could link to the discussion or some doc explain why we
> > > do this kind of change.
> > > It's good practice to share the development context across the
> community.
> > >
> > > It could be a pain for the first contributor to submit his first PR,
> > > but with the guide document will reduce that pain.
> > >
> > > Just my 2 cents.
> > >
> > > Willem Jiang
> > >
> > > Twitter: willemjiang
> > > Weibo: 姜宁willem
> > >
> > > On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <wu...@gmail.com>
> > wrote:
> > > >
> > > > Hi
> > > >
> > > > This kind of requirement should come from a high diversity and very
> > > active
> > > > community, like the example your using.
> > > > The only reason the commit log important, is because of quick review
> > > update
> > > > and revert in some critical case.
> > > >
> > > > From the commit log today, there is not that case.
> > > > https://github.com/apache/incubator-echarts/commits/master
> > > >
> > > > I am supporting commit id as better as possible, but also, PPMC
> please
> > > > consider Justin's question/concern, don't make a higher bar than
> > before.
> > > >
> > > > Sheng Wu 吴晟
> > > >
> > > > Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> > > > Twitter, wusheng1108
> > > >
> > > >
> > > > Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
> > > >
> > > > > Hi,
> > > > > Just out of interest what is the problem you're trying to solve
> here?
> > > It
> > > > > seem to me that doing something like this will make it harder for
> > > users to
> > > > > contribute, when you want to make it easier for them to do so.
> > > > > Thanks,
> > > > > Justin
> > > > >
> > > > >
> ---------------------------------------------------------------------
> > > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > > >
> > > > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > For additional commands, e-mail: dev-help@echarts.apache.org
> > >
> > >
> >
>

Re: [DISCUSS] Git message guidelines

Posted by Yi Shen <sh...@gmail.com>.
I think we are all agree about writing a commit message should not be a
trouble to our developers :)

Shuang's point is we should not block developer's commit because of
validation tool. And my point is we may use tools to help us writing a
clean commit message.

On Wed, Sep 4, 2019 at 11:05 AM Ovilia <ov...@gmail.com> wrote:

> Hi Clement,
>
> What's the process if we add this in CI?
>
> I was considering making these guidelines not compulsory for the community
> to avoid the roundtrips as you mentioned, and the commit message can be
> updated by who approved the pull request in the squashing stage.
>
> Wenli
>
>
> On Wed, Sep 4, 2019 at 8:45 AM Clement Ho <cl...@gitlab.com.invalid>
> wrote:
>
> > I'm also concerned that this may create more roundtrips during code
> reviews
> > from the community (if we don't automate parts of it)
> >
> > On Tue, Sep 3, 2019 at 7:43 PM Willem Jiang <wi...@gmail.com>
> > wrote:
> >
> > > I think providing the fix issue id is quite important for the others
> > > who want to dig the code.
> > > The issue id could link to the discussion or some doc explain why we
> > > do this kind of change.
> > > It's good practice to share the development context across the
> community.
> > >
> > > It could be a pain for the first contributor to submit his first PR,
> > > but with the guide document will reduce that pain.
> > >
> > > Just my 2 cents.
> > >
> > > Willem Jiang
> > >
> > > Twitter: willemjiang
> > > Weibo: 姜宁willem
> > >
> > > On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <wu...@gmail.com>
> > wrote:
> > > >
> > > > Hi
> > > >
> > > > This kind of requirement should come from a high diversity and very
> > > active
> > > > community, like the example your using.
> > > > The only reason the commit log important, is because of quick review
> > > update
> > > > and revert in some critical case.
> > > >
> > > > From the commit log today, there is not that case.
> > > > https://github.com/apache/incubator-echarts/commits/master
> > > >
> > > > I am supporting commit id as better as possible, but also, PPMC
> please
> > > > consider Justin's question/concern, don't make a higher bar than
> > before.
> > > >
> > > > Sheng Wu 吴晟
> > > >
> > > > Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> > > > Twitter, wusheng1108
> > > >
> > > >
> > > > Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
> > > >
> > > > > Hi,
> > > > > Just out of interest what is the problem you're trying to solve
> here?
> > > It
> > > > > seem to me that doing something like this will make it harder for
> > > users to
> > > > > contribute, when you want to make it easier for them to do so.
> > > > > Thanks,
> > > > > Justin
> > > > >
> > > > >
> ---------------------------------------------------------------------
> > > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > > >
> > > > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > For additional commands, e-mail: dev-help@echarts.apache.org
> > >
> > >
> >
>


-- 
Yi Shen
Senior Developer
Baidu, Inc.

Re: [DISCUSS] Git message guidelines

Posted by Ovilia <ov...@gmail.com>.
Hi Clement,

What's the process if we add this in CI?

I was considering making these guidelines not compulsory for the community
to avoid the roundtrips as you mentioned, and the commit message can be
updated by who approved the pull request in the squashing stage.

Wenli


On Wed, Sep 4, 2019 at 8:45 AM Clement Ho <cl...@gitlab.com.invalid>
wrote:

> I'm also concerned that this may create more roundtrips during code reviews
> from the community (if we don't automate parts of it)
>
> On Tue, Sep 3, 2019 at 7:43 PM Willem Jiang <wi...@gmail.com>
> wrote:
>
> > I think providing the fix issue id is quite important for the others
> > who want to dig the code.
> > The issue id could link to the discussion or some doc explain why we
> > do this kind of change.
> > It's good practice to share the development context across the community.
> >
> > It could be a pain for the first contributor to submit his first PR,
> > but with the guide document will reduce that pain.
> >
> > Just my 2 cents.
> >
> > Willem Jiang
> >
> > Twitter: willemjiang
> > Weibo: 姜宁willem
> >
> > On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <wu...@gmail.com>
> wrote:
> > >
> > > Hi
> > >
> > > This kind of requirement should come from a high diversity and very
> > active
> > > community, like the example your using.
> > > The only reason the commit log important, is because of quick review
> > update
> > > and revert in some critical case.
> > >
> > > From the commit log today, there is not that case.
> > > https://github.com/apache/incubator-echarts/commits/master
> > >
> > > I am supporting commit id as better as possible, but also, PPMC please
> > > consider Justin's question/concern, don't make a higher bar than
> before.
> > >
> > > Sheng Wu 吴晟
> > >
> > > Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> > > Twitter, wusheng1108
> > >
> > >
> > > Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
> > >
> > > > Hi,
> > > > Just out of interest what is the problem you're trying to solve here?
> > It
> > > > seem to me that doing something like this will make it harder for
> > users to
> > > > contribute, when you want to make it easier for them to do so.
> > > > Thanks,
> > > > Justin
> > > >
> > > > ---------------------------------------------------------------------
> > > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > > For additional commands, e-mail: dev-help@echarts.apache.org
> > > >
> > > >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > For additional commands, e-mail: dev-help@echarts.apache.org
> >
> >
>

Re: [DISCUSS] Git message guidelines

Posted by Clement Ho <cl...@gitlab.com.INVALID>.
I'm also concerned that this may create more roundtrips during code reviews
from the community (if we don't automate parts of it)

On Tue, Sep 3, 2019 at 7:43 PM Willem Jiang <wi...@gmail.com> wrote:

> I think providing the fix issue id is quite important for the others
> who want to dig the code.
> The issue id could link to the discussion or some doc explain why we
> do this kind of change.
> It's good practice to share the development context across the community.
>
> It could be a pain for the first contributor to submit his first PR,
> but with the guide document will reduce that pain.
>
> Just my 2 cents.
>
> Willem Jiang
>
> Twitter: willemjiang
> Weibo: 姜宁willem
>
> On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <wu...@gmail.com> wrote:
> >
> > Hi
> >
> > This kind of requirement should come from a high diversity and very
> active
> > community, like the example your using.
> > The only reason the commit log important, is because of quick review
> update
> > and revert in some critical case.
> >
> > From the commit log today, there is not that case.
> > https://github.com/apache/incubator-echarts/commits/master
> >
> > I am supporting commit id as better as possible, but also, PPMC please
> > consider Justin's question/concern, don't make a higher bar than before.
> >
> > Sheng Wu 吴晟
> >
> > Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> > Twitter, wusheng1108
> >
> >
> > Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
> >
> > > Hi,
> > > Just out of interest what is the problem you're trying to solve here?
> It
> > > seem to me that doing something like this will make it harder for
> users to
> > > contribute, when you want to make it easier for them to do so.
> > > Thanks,
> > > Justin
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > > For additional commands, e-mail: dev-help@echarts.apache.org
> > >
> > >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> For additional commands, e-mail: dev-help@echarts.apache.org
>
>

Re: [DISCUSS] Git message guidelines

Posted by Willem Jiang <wi...@gmail.com>.
I think providing the fix issue id is quite important for the others
who want to dig the code.
The issue id could link to the discussion or some doc explain why we
do this kind of change.
It's good practice to share the development context across the community.

It could be a pain for the first contributor to submit his first PR,
but with the guide document will reduce that pain.

Just my 2 cents.

Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem

On Wed, Sep 4, 2019 at 6:40 AM Sheng Wu <wu...@gmail.com> wrote:
>
> Hi
>
> This kind of requirement should come from a high diversity and very active
> community, like the example your using.
> The only reason the commit log important, is because of quick review update
> and revert in some critical case.
>
> From the commit log today, there is not that case.
> https://github.com/apache/incubator-echarts/commits/master
>
> I am supporting commit id as better as possible, but also, PPMC please
> consider Justin's question/concern, don't make a higher bar than before.
>
> Sheng Wu 吴晟
>
> Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
> Twitter, wusheng1108
>
>
> Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:
>
> > Hi,
> > Just out of interest what is the problem you're trying to solve here? It
> > seem to me that doing something like this will make it harder for users to
> > contribute, when you want to make it easier for them to do so.
> > Thanks,
> > Justin
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> > For additional commands, e-mail: dev-help@echarts.apache.org
> >
> >

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
For additional commands, e-mail: dev-help@echarts.apache.org


Re: [DISCUSS] Git message guidelines

Posted by Sheng Wu <wu...@gmail.com>.
Hi

This kind of requirement should come from a high diversity and very active
community, like the example your using.
The only reason the commit log important, is because of quick review update
and revert in some critical case.

From the commit log today, there is not that case.
https://github.com/apache/incubator-echarts/commits/master

I am supporting commit id as better as possible, but also, PPMC please
consider Justin's question/concern, don't make a higher bar than before.

Sheng Wu 吴晟

Apache SkyWalking, Apache ShardingSphere(Incubating), Zipkin
Twitter, wusheng1108


Justin Mclean <jm...@apache.org> 于2019年9月3日周二 下午3:34写道:

> Hi,
> Just out of interest what is the problem you're trying to solve here? It
> seem to me that doing something like this will make it harder for users to
> contribute, when you want to make it easier for them to do so.
> Thanks,
> Justin
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
> For additional commands, e-mail: dev-help@echarts.apache.org
>
>

Re: [DISCUSS] Git message guidelines

Posted by Justin Mclean <jm...@apache.org>.
Hi,
Just out of interest what is the problem you're trying to solve here? It seem to me that doing something like this will make it harder for users to contribute, when you want to make it easier for them to do so.
Thanks,
Justin

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@echarts.apache.org
For additional commands, e-mail: dev-help@echarts.apache.org


Re: [VOTE] Git message guidelines

Posted by Yi Shen <sh...@gmail.com>.
+1

On Mon, Sep 2, 2019 at 3:16 PM Ovilia <ov...@gmail.com> wrote:

> Let's have a vote on this.
>
> If you agree on the following guidelines, please +1.
>
> 1. Based on the Angular.js git message guidelines [1], and change about
> the issue number part, making it something like:
>
> fix(svg): change the default behavior of download image with toolbox; fix
> #12345
>
> 2. We may provide tools like cz-cli [2] to help developers to commit using
> this guidelines, but it's not compulsory.
>
> 3. When commits are made from pull requests from the community, who didn't
> follow the guidelines, we should use "squash and commit" when merging and
> commit using guidelines.
>
> [1]
> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
> [2] https://github.com/commitizen/cz-cli
>
> Wenli
>
>
> On Sat, Aug 31, 2019 at 4:37 PM Ovilia <ov...@gmail.com> wrote:
>
>> If developers are not ussing our git message guidelines, we can still
>> squash the commits into a single one and edit message by ourselves.
>>
>> Wenli
>>
>>
>> On Fri, Aug 30, 2019 at 9:57 PM Yi Shen <sh...@gmail.com> wrote:
>>
>>> Agree with the guidelines.
>>>
>>>  those tools, like "git-cz", bring more troubles than benefits
>>>>
>>>
>>> We should use tools like commitizen[1] to help us write good commits
>>> message.
>>>
>>> I guess we can't force developers to use tools like 'git-cz' to validate
>>> the commits in their pull requests?
>>>
>>> [1] https://github.com/commitizen/cz-cli
>>>
>>> On Fri, Aug 30, 2019 at 6:11 PM SHUANG SU <su...@gmail.com>
>>> wrote:
>>>
>>>> I agree with that commit message should follow a guideline, which will
>>>> also make changelog collection work easy.
>>>>
>>>> But I suggest that do not use some tool to force us to commit like
>>>> that. In my experience, those tools, like "git-cz",
>>>> bring more troubles than benefits, especially when developers using
>>>> some git GUI tools, always
>>>> some error throws so that developers have to find how to config to
>>>> avoid that.
>>>>
>>>>
>>>> ------------------------------
>>>>  Su Shuang (100pah)
>>>> ------------------------------
>>>>
>>>>
>>>>
>>>> On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:
>>>>
>>>>> Currently, we do not have a standard for git message guidelines, so
>>>>> the commit logs may look a little untidy [1].
>>>>>
>>>>> A very popular commit guideline is from Angular.js [2], which I think
>>>>> is very nice only that it includes issue number at the footer.
>>>>> For example, with Angular.js's commit guideline, a commit message may
>>>>> be:
>>>>> fix(svg): change the default behavior of download image with toolbox
>>>>> fix #12345
>>>>>
>>>>> I think putting the issue number at the end of the subject may be a
>>>>> better idea.
>>>>> Because if the issue number is not included in the first line, it will
>>>>> only be visible when "..." is clicked.
>>>>> Issue number, and more importantly, the link to the issue is a very
>>>>> important part of a git message.
>>>>> [image: commit message.png]
>>>>>
>>>>> My suggest is, to follow the Angular.js git message guidelines, and
>>>>> change about the issue number part, making it something like:
>>>>>
>>>>> fix(svg): change the default behavior of download image with toolbox;
>>>>> fix #12345
>>>>>
>>>>>
>>>>> [1] https://github.com/apache/incubator-echarts/commits/master
>>>>> [2]
>>>>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>>>>
>>>>> Wenli
>>>>>
>>>>
>>>
>>> --
>>> Yi Shen
>>> Senior Developer
>>> Baidu, Inc.
>>>
>>

-- 
Yi Shen
Senior Developer
Baidu, Inc.

Re: [VOTE] Git message guidelines

Posted by Clement Ho <cl...@gitlab.com.INVALID>.
I’m all for this as long as we use CI to lint for the commit messages and
provide clear instructions on how users can fix their previous commits

On Tue, Sep 3, 2019 at 7:14 AM Ovilia <ov...@gmail.com> wrote:

> Sure. Thanks, Willem.
>
> I just found GitHub add (#pr_id) to the end of squashed log like:
> fix(svg): svg doesn't support addHover; fix #11054 (#11156)
>
> in which #11054 is the bug report issue id, and #11156 is the pull request
> id.
>
> Well, I think we don't need to vote again.
> I will write the guidelines down and let you check out.
>
> Wenli
>
>
> On Tue, Sep 3, 2019 at 7:27 PM Willem Jiang <wi...@gmail.com>
> wrote:
>
>> Just a remind, if we want to start a vote after discussion, we could
>> start a new thread for it.
>> It could save us some time to check the votes.
>>
>> Willem Jiang
>>
>> Twitter: willemjiang
>> Weibo: 姜宁willem
>>
>>
>> On Mon, Sep 2, 2019 at 3:16 PM Ovilia <ov...@gmail.com> wrote:
>>
>>> Let's have a vote on this.
>>>
>>> If you agree on the following guidelines, please +1.
>>>
>>> 1. Based on the Angular.js git message guidelines [1], and change about
>>> the issue number part, making it something like:
>>>
>>> fix(svg): change the default behavior of download image with toolbox;
>>> fix #12345
>>>
>>> 2. We may provide tools like cz-cli [2] to help developers to commit
>>> using this guidelines, but it's not compulsory.
>>>
>>> 3. When commits are made from pull requests from the community, who
>>> didn't follow the guidelines, we should use "squash and commit" when
>>> merging and commit using guidelines.
>>>
>>> [1]
>>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>> [2] https://github.com/commitizen/cz-cli
>>>
>>> Wenli
>>>
>>>
>>> On Sat, Aug 31, 2019 at 4:37 PM Ovilia <ov...@gmail.com> wrote:
>>>
>>>> If developers are not ussing our git message guidelines, we can still
>>>> squash the commits into a single one and edit message by ourselves.
>>>>
>>>> Wenli
>>>>
>>>>
>>>> On Fri, Aug 30, 2019 at 9:57 PM Yi Shen <sh...@gmail.com> wrote:
>>>>
>>>>> Agree with the guidelines.
>>>>>
>>>>>  those tools, like "git-cz", bring more troubles than benefits
>>>>>>
>>>>>
>>>>> We should use tools like commitizen[1] to help us write good commits
>>>>> message.
>>>>>
>>>>> I guess we can't force developers to use tools like 'git-cz' to
>>>>> validate the commits in their pull requests?
>>>>>
>>>>> [1] https://github.com/commitizen/cz-cli
>>>>>
>>>>> On Fri, Aug 30, 2019 at 6:11 PM SHUANG SU <su...@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> I agree with that commit message should follow a guideline, which
>>>>>> will also make changelog collection work easy.
>>>>>>
>>>>>> But I suggest that do not use some tool to force us to commit like
>>>>>> that. In my experience, those tools, like "git-cz",
>>>>>> bring more troubles than benefits, especially when developers using
>>>>>> some git GUI tools, always
>>>>>> some error throws so that developers have to find how to config to
>>>>>> avoid that.
>>>>>>
>>>>>>
>>>>>> ------------------------------
>>>>>>  Su Shuang (100pah)
>>>>>> ------------------------------
>>>>>>
>>>>>>
>>>>>>
>>>>>> On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:
>>>>>>
>>>>>>> Currently, we do not have a standard for git message guidelines, so
>>>>>>> the commit logs may look a little untidy [1].
>>>>>>>
>>>>>>> A very popular commit guideline is from Angular.js [2], which I
>>>>>>> think is very nice only that it includes issue number at the footer.
>>>>>>> For example, with Angular.js's commit guideline, a commit message
>>>>>>> may be:
>>>>>>> fix(svg): change the default behavior of download image with toolbox
>>>>>>> fix #12345
>>>>>>>
>>>>>>> I think putting the issue number at the end of the subject may be a
>>>>>>> better idea.
>>>>>>> Because if the issue number is not included in the first line, it
>>>>>>> will only be visible when "..." is clicked.
>>>>>>> Issue number, and more importantly, the link to the issue is a very
>>>>>>> important part of a git message.
>>>>>>> [image: commit message.png]
>>>>>>>
>>>>>>> My suggest is, to follow the Angular.js git message guidelines, and
>>>>>>> change about the issue number part, making it something like:
>>>>>>>
>>>>>>> fix(svg): change the default behavior of download image with
>>>>>>> toolbox; fix #12345
>>>>>>>
>>>>>>>
>>>>>>> [1] https://github.com/apache/incubator-echarts/commits/master
>>>>>>> [2]
>>>>>>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>>>>>>
>>>>>>> Wenli
>>>>>>>
>>>>>>
>>>>>
>>>>> --
>>>>> Yi Shen
>>>>> Senior Developer
>>>>> Baidu, Inc.
>>>>>
>>>>

Re: [VOTE] Git message guidelines

Posted by Ovilia <ov...@gmail.com>.
Sure. Thanks, Willem.

I just found GitHub add (#pr_id) to the end of squashed log like:
fix(svg): svg doesn't support addHover; fix #11054 (#11156)

in which #11054 is the bug report issue id, and #11156 is the pull request
id.

Well, I think we don't need to vote again.
I will write the guidelines down and let you check out.

Wenli


On Tue, Sep 3, 2019 at 7:27 PM Willem Jiang <wi...@gmail.com> wrote:

> Just a remind, if we want to start a vote after discussion, we could start
> a new thread for it.
> It could save us some time to check the votes.
>
> Willem Jiang
>
> Twitter: willemjiang
> Weibo: 姜宁willem
>
>
> On Mon, Sep 2, 2019 at 3:16 PM Ovilia <ov...@gmail.com> wrote:
>
>> Let's have a vote on this.
>>
>> If you agree on the following guidelines, please +1.
>>
>> 1. Based on the Angular.js git message guidelines [1], and change about
>> the issue number part, making it something like:
>>
>> fix(svg): change the default behavior of download image with toolbox;
>> fix #12345
>>
>> 2. We may provide tools like cz-cli [2] to help developers to commit
>> using this guidelines, but it's not compulsory.
>>
>> 3. When commits are made from pull requests from the community, who
>> didn't follow the guidelines, we should use "squash and commit" when
>> merging and commit using guidelines.
>>
>> [1]
>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>> [2] https://github.com/commitizen/cz-cli
>>
>> Wenli
>>
>>
>> On Sat, Aug 31, 2019 at 4:37 PM Ovilia <ov...@gmail.com> wrote:
>>
>>> If developers are not ussing our git message guidelines, we can still
>>> squash the commits into a single one and edit message by ourselves.
>>>
>>> Wenli
>>>
>>>
>>> On Fri, Aug 30, 2019 at 9:57 PM Yi Shen <sh...@gmail.com> wrote:
>>>
>>>> Agree with the guidelines.
>>>>
>>>>  those tools, like "git-cz", bring more troubles than benefits
>>>>>
>>>>
>>>> We should use tools like commitizen[1] to help us write good commits
>>>> message.
>>>>
>>>> I guess we can't force developers to use tools like 'git-cz' to
>>>> validate the commits in their pull requests?
>>>>
>>>> [1] https://github.com/commitizen/cz-cli
>>>>
>>>> On Fri, Aug 30, 2019 at 6:11 PM SHUANG SU <su...@gmail.com>
>>>> wrote:
>>>>
>>>>> I agree with that commit message should follow a guideline, which will
>>>>> also make changelog collection work easy.
>>>>>
>>>>> But I suggest that do not use some tool to force us to commit like
>>>>> that. In my experience, those tools, like "git-cz",
>>>>> bring more troubles than benefits, especially when developers using
>>>>> some git GUI tools, always
>>>>> some error throws so that developers have to find how to config to
>>>>> avoid that.
>>>>>
>>>>>
>>>>> ------------------------------
>>>>>  Su Shuang (100pah)
>>>>> ------------------------------
>>>>>
>>>>>
>>>>>
>>>>> On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:
>>>>>
>>>>>> Currently, we do not have a standard for git message guidelines, so
>>>>>> the commit logs may look a little untidy [1].
>>>>>>
>>>>>> A very popular commit guideline is from Angular.js [2], which I think
>>>>>> is very nice only that it includes issue number at the footer.
>>>>>> For example, with Angular.js's commit guideline, a commit message may
>>>>>> be:
>>>>>> fix(svg): change the default behavior of download image with toolbox
>>>>>> fix #12345
>>>>>>
>>>>>> I think putting the issue number at the end of the subject may be a
>>>>>> better idea.
>>>>>> Because if the issue number is not included in the first line, it
>>>>>> will only be visible when "..." is clicked.
>>>>>> Issue number, and more importantly, the link to the issue is a very
>>>>>> important part of a git message.
>>>>>> [image: commit message.png]
>>>>>>
>>>>>> My suggest is, to follow the Angular.js git message guidelines, and
>>>>>> change about the issue number part, making it something like:
>>>>>>
>>>>>> fix(svg): change the default behavior of download image with
>>>>>> toolbox; fix #12345
>>>>>>
>>>>>>
>>>>>> [1] https://github.com/apache/incubator-echarts/commits/master
>>>>>> [2]
>>>>>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>>>>>
>>>>>> Wenli
>>>>>>
>>>>>
>>>>
>>>> --
>>>> Yi Shen
>>>> Senior Developer
>>>> Baidu, Inc.
>>>>
>>>

Re: [VOTE] Git message guidelines

Posted by Willem Jiang <wi...@gmail.com>.
Just a remind, if we want to start a vote after discussion, we could start
a new thread for it.
It could save us some time to check the votes.

Willem Jiang

Twitter: willemjiang
Weibo: 姜宁willem


On Mon, Sep 2, 2019 at 3:16 PM Ovilia <ov...@gmail.com> wrote:

> Let's have a vote on this.
>
> If you agree on the following guidelines, please +1.
>
> 1. Based on the Angular.js git message guidelines [1], and change about
> the issue number part, making it something like:
>
> fix(svg): change the default behavior of download image with toolbox; fix
> #12345
>
> 2. We may provide tools like cz-cli [2] to help developers to commit using
> this guidelines, but it's not compulsory.
>
> 3. When commits are made from pull requests from the community, who didn't
> follow the guidelines, we should use "squash and commit" when merging and
> commit using guidelines.
>
> [1]
> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
> [2] https://github.com/commitizen/cz-cli
>
> Wenli
>
>
> On Sat, Aug 31, 2019 at 4:37 PM Ovilia <ov...@gmail.com> wrote:
>
>> If developers are not ussing our git message guidelines, we can still
>> squash the commits into a single one and edit message by ourselves.
>>
>> Wenli
>>
>>
>> On Fri, Aug 30, 2019 at 9:57 PM Yi Shen <sh...@gmail.com> wrote:
>>
>>> Agree with the guidelines.
>>>
>>>  those tools, like "git-cz", bring more troubles than benefits
>>>>
>>>
>>> We should use tools like commitizen[1] to help us write good commits
>>> message.
>>>
>>> I guess we can't force developers to use tools like 'git-cz' to validate
>>> the commits in their pull requests?
>>>
>>> [1] https://github.com/commitizen/cz-cli
>>>
>>> On Fri, Aug 30, 2019 at 6:11 PM SHUANG SU <su...@gmail.com>
>>> wrote:
>>>
>>>> I agree with that commit message should follow a guideline, which will
>>>> also make changelog collection work easy.
>>>>
>>>> But I suggest that do not use some tool to force us to commit like
>>>> that. In my experience, those tools, like "git-cz",
>>>> bring more troubles than benefits, especially when developers using
>>>> some git GUI tools, always
>>>> some error throws so that developers have to find how to config to
>>>> avoid that.
>>>>
>>>>
>>>> ------------------------------
>>>>  Su Shuang (100pah)
>>>> ------------------------------
>>>>
>>>>
>>>>
>>>> On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:
>>>>
>>>>> Currently, we do not have a standard for git message guidelines, so
>>>>> the commit logs may look a little untidy [1].
>>>>>
>>>>> A very popular commit guideline is from Angular.js [2], which I think
>>>>> is very nice only that it includes issue number at the footer.
>>>>> For example, with Angular.js's commit guideline, a commit message may
>>>>> be:
>>>>> fix(svg): change the default behavior of download image with toolbox
>>>>> fix #12345
>>>>>
>>>>> I think putting the issue number at the end of the subject may be a
>>>>> better idea.
>>>>> Because if the issue number is not included in the first line, it will
>>>>> only be visible when "..." is clicked.
>>>>> Issue number, and more importantly, the link to the issue is a very
>>>>> important part of a git message.
>>>>> [image: commit message.png]
>>>>>
>>>>> My suggest is, to follow the Angular.js git message guidelines, and
>>>>> change about the issue number part, making it something like:
>>>>>
>>>>> fix(svg): change the default behavior of download image with toolbox;
>>>>> fix #12345
>>>>>
>>>>>
>>>>> [1] https://github.com/apache/incubator-echarts/commits/master
>>>>> [2]
>>>>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>>>>
>>>>> Wenli
>>>>>
>>>>
>>>
>>> --
>>> Yi Shen
>>> Senior Developer
>>> Baidu, Inc.
>>>
>>

[VOTE] Git message guidelines

Posted by Ovilia <ov...@gmail.com>.
Let's have a vote on this.

If you agree on the following guidelines, please +1.

1. Based on the Angular.js git message guidelines [1], and change about the
issue number part, making it something like:

fix(svg): change the default behavior of download image with toolbox; fix
#12345

2. We may provide tools like cz-cli [2] to help developers to commit using
this guidelines, but it's not compulsory.

3. When commits are made from pull requests from the community, who didn't
follow the guidelines, we should use "squash and commit" when merging and
commit using guidelines.

[1]
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
[2] https://github.com/commitizen/cz-cli

Wenli


On Sat, Aug 31, 2019 at 4:37 PM Ovilia <ov...@gmail.com> wrote:

> If developers are not ussing our git message guidelines, we can still
> squash the commits into a single one and edit message by ourselves.
>
> Wenli
>
>
> On Fri, Aug 30, 2019 at 9:57 PM Yi Shen <sh...@gmail.com> wrote:
>
>> Agree with the guidelines.
>>
>>  those tools, like "git-cz", bring more troubles than benefits
>>>
>>
>> We should use tools like commitizen[1] to help us write good commits
>> message.
>>
>> I guess we can't force developers to use tools like 'git-cz' to validate
>> the commits in their pull requests?
>>
>> [1] https://github.com/commitizen/cz-cli
>>
>> On Fri, Aug 30, 2019 at 6:11 PM SHUANG SU <su...@gmail.com> wrote:
>>
>>> I agree with that commit message should follow a guideline, which will
>>> also make changelog collection work easy.
>>>
>>> But I suggest that do not use some tool to force us to commit like that.
>>> In my experience, those tools, like "git-cz",
>>> bring more troubles than benefits, especially when developers using some
>>> git GUI tools, always
>>> some error throws so that developers have to find how to config to avoid
>>> that.
>>>
>>>
>>> ------------------------------
>>>  Su Shuang (100pah)
>>> ------------------------------
>>>
>>>
>>>
>>> On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:
>>>
>>>> Currently, we do not have a standard for git message guidelines, so the
>>>> commit logs may look a little untidy [1].
>>>>
>>>> A very popular commit guideline is from Angular.js [2], which I think
>>>> is very nice only that it includes issue number at the footer.
>>>> For example, with Angular.js's commit guideline, a commit message may
>>>> be:
>>>> fix(svg): change the default behavior of download image with toolbox
>>>> fix #12345
>>>>
>>>> I think putting the issue number at the end of the subject may be a
>>>> better idea.
>>>> Because if the issue number is not included in the first line, it will
>>>> only be visible when "..." is clicked.
>>>> Issue number, and more importantly, the link to the issue is a very
>>>> important part of a git message.
>>>> [image: commit message.png]
>>>>
>>>> My suggest is, to follow the Angular.js git message guidelines, and
>>>> change about the issue number part, making it something like:
>>>>
>>>> fix(svg): change the default behavior of download image with toolbox;
>>>> fix #12345
>>>>
>>>>
>>>> [1] https://github.com/apache/incubator-echarts/commits/master
>>>> [2]
>>>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>>>
>>>> Wenli
>>>>
>>>
>>
>> --
>> Yi Shen
>> Senior Developer
>> Baidu, Inc.
>>
>

Re: [DISCUSS] Git message guidelines

Posted by Ovilia <ov...@gmail.com>.
If developers are not ussing our git message guidelines, we can still
squash the commits into a single one and edit message by ourselves.

Wenli


On Fri, Aug 30, 2019 at 9:57 PM Yi Shen <sh...@gmail.com> wrote:

> Agree with the guidelines.
>
>  those tools, like "git-cz", bring more troubles than benefits
>>
>
> We should use tools like commitizen[1] to help us write good commits
> message.
>
> I guess we can't force developers to use tools like 'git-cz' to validate
> the commits in their pull requests?
>
> [1] https://github.com/commitizen/cz-cli
>
> On Fri, Aug 30, 2019 at 6:11 PM SHUANG SU <su...@gmail.com> wrote:
>
>> I agree with that commit message should follow a guideline, which will
>> also make changelog collection work easy.
>>
>> But I suggest that do not use some tool to force us to commit like that.
>> In my experience, those tools, like "git-cz",
>> bring more troubles than benefits, especially when developers using some
>> git GUI tools, always
>> some error throws so that developers have to find how to config to avoid
>> that.
>>
>>
>> ------------------------------
>>  Su Shuang (100pah)
>> ------------------------------
>>
>>
>>
>> On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:
>>
>>> Currently, we do not have a standard for git message guidelines, so the
>>> commit logs may look a little untidy [1].
>>>
>>> A very popular commit guideline is from Angular.js [2], which I think is
>>> very nice only that it includes issue number at the footer.
>>> For example, with Angular.js's commit guideline, a commit message may be:
>>> fix(svg): change the default behavior of download image with toolbox
>>> fix #12345
>>>
>>> I think putting the issue number at the end of the subject may be a
>>> better idea.
>>> Because if the issue number is not included in the first line, it will
>>> only be visible when "..." is clicked.
>>> Issue number, and more importantly, the link to the issue is a very
>>> important part of a git message.
>>> [image: commit message.png]
>>>
>>> My suggest is, to follow the Angular.js git message guidelines, and
>>> change about the issue number part, making it something like:
>>>
>>> fix(svg): change the default behavior of download image with toolbox;
>>> fix #12345
>>>
>>>
>>> [1] https://github.com/apache/incubator-echarts/commits/master
>>> [2]
>>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>>
>>> Wenli
>>>
>>
>
> --
> Yi Shen
> Senior Developer
> Baidu, Inc.
>

Re: [DISCUSS] Git message guidelines

Posted by Yi Shen <sh...@gmail.com>.
Agree with the guidelines.

 those tools, like "git-cz", bring more troubles than benefits
>

We should use tools like commitizen[1] to help us write good commits
message.

I guess we can't force developers to use tools like 'git-cz' to validate
the commits in their pull requests?

[1] https://github.com/commitizen/cz-cli

On Fri, Aug 30, 2019 at 6:11 PM SHUANG SU <su...@gmail.com> wrote:

> I agree with that commit message should follow a guideline, which will
> also make changelog collection work easy.
>
> But I suggest that do not use some tool to force us to commit like that.
> In my experience, those tools, like "git-cz",
> bring more troubles than benefits, especially when developers using some
> git GUI tools, always
> some error throws so that developers have to find how to config to avoid
> that.
>
>
> ------------------------------
>  Su Shuang (100pah)
> ------------------------------
>
>
>
> On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:
>
>> Currently, we do not have a standard for git message guidelines, so the
>> commit logs may look a little untidy [1].
>>
>> A very popular commit guideline is from Angular.js [2], which I think is
>> very nice only that it includes issue number at the footer.
>> For example, with Angular.js's commit guideline, a commit message may be:
>> fix(svg): change the default behavior of download image with toolbox
>> fix #12345
>>
>> I think putting the issue number at the end of the subject may be a
>> better idea.
>> Because if the issue number is not included in the first line, it will
>> only be visible when "..." is clicked.
>> Issue number, and more importantly, the link to the issue is a very
>> important part of a git message.
>> [image: commit message.png]
>>
>> My suggest is, to follow the Angular.js git message guidelines, and
>> change about the issue number part, making it something like:
>>
>> fix(svg): change the default behavior of download image with toolbox;
>> fix #12345
>>
>>
>> [1] https://github.com/apache/incubator-echarts/commits/master
>> [2]
>> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>>
>> Wenli
>>
>

-- 
Yi Shen
Senior Developer
Baidu, Inc.

Re: [DISCUSS] Git message guidelines

Posted by SHUANG SU <su...@gmail.com>.
I agree with that commit message should follow a guideline, which will also
make changelog collection work easy.

But I suggest that do not use some tool to force us to commit like that. In
my experience, those tools, like "git-cz",
bring more troubles than benefits, especially when developers using some
git GUI tools, always
some error throws so that developers have to find how to config to avoid
that.


------------------------------
 Su Shuang (100pah)
------------------------------



On Fri, 30 Aug 2019 at 17:57, Ovilia <ov...@gmail.com> wrote:

> Currently, we do not have a standard for git message guidelines, so the
> commit logs may look a little untidy [1].
>
> A very popular commit guideline is from Angular.js [2], which I think is
> very nice only that it includes issue number at the footer.
> For example, with Angular.js's commit guideline, a commit message may be:
> fix(svg): change the default behavior of download image with toolbox
> fix #12345
>
> I think putting the issue number at the end of the subject may be a better
> idea.
> Because if the issue number is not included in the first line, it will
> only be visible when "..." is clicked.
> Issue number, and more importantly, the link to the issue is a very
> important part of a git message.
> [image: commit message.png]
>
> My suggest is, to follow the Angular.js git message guidelines, and change
> about the issue number part, making it something like:
>
> fix(svg): change the default behavior of download image with toolbox; fix
> #12345
>
>
> [1] https://github.com/apache/incubator-echarts/commits/master
> [2]
> https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines
>
> Wenli
>