You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@calcite.apache.org by Stamatis Zampetakis <za...@gmail.com> on 2021/09/23 09:22:48 UTC
[DISCUSS] Remove contributors name from commit summary
Hi all,
Currently we are supposed to append the contributors name to the commit
summary when they are not committers of the project. The main reason for
doing this if I am not mistaken is to give some credit to those people.
I did like this practice in the beginning but I think it adds some small
overhead to all parties involved (committers and contributors).
The contributor quite often forgets to include the name in the end so the
burden to find and append the name goes to the committer.
In various cases, I've seen PRs ready to merge which were actually missing
the name at the end. What usually happens afterwards is one of the
following:
* the committer merges the PR without amending the name;
* the committer rebases the PR, amends the commit, and merges it;
* the committer asks the contributor to change the commit message;
I would prefer it if we could avoid this overhead by changing the commit
guidelines to not append the contributors name at the end.
GitHub does a great job giving credit to contributors. Moreover in most
cases the name appears in the log under the author tag so it is very easy
to exploit if we want to extract information and statistics.
What do you think?
Best,
Stamatis
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Michael Mior <mm...@apache.org>.
+1 One of the reasons it was there was to make generating the
changelog easier. However, this could be easily scripted to pull out
the contributors name if needed.
--
Michael Mior
mmior@apache.org
Le jeu. 23 sept. 2021 à 05:23, Stamatis Zampetakis <za...@gmail.com> a écrit :
>
> Hi all,
>
> Currently we are supposed to append the contributors name to the commit
> summary when they are not committers of the project. The main reason for
> doing this if I am not mistaken is to give some credit to those people.
>
> I did like this practice in the beginning but I think it adds some small
> overhead to all parties involved (committers and contributors).
>
> The contributor quite often forgets to include the name in the end so the
> burden to find and append the name goes to the committer.
>
> In various cases, I've seen PRs ready to merge which were actually missing
> the name at the end. What usually happens afterwards is one of the
> following:
> * the committer merges the PR without amending the name;
> * the committer rebases the PR, amends the commit, and merges it;
> * the committer asks the contributor to change the commit message;
>
> I would prefer it if we could avoid this overhead by changing the commit
> guidelines to not append the contributors name at the end.
>
> GitHub does a great job giving credit to contributors. Moreover in most
> cases the name appears in the log under the author tag so it is very easy
> to exploit if we want to extract information and statistics.
>
> What do you think?
>
> Best,
> Stamatis
回复：[DISCUSS] Remove contributors name from commit summary
Posted by 953396112 <13...@qq.com.INVALID>.
agree with you, +1
------------------ 原始邮件 ------------------
发件人: "dev" <zabetak@gmail.com>;
发送时间: 2021年9月23日(星期四) 下午5:22
收件人: "dev"<dev@calcite.apache.org>;
主题: [DISCUSS] Remove contributors name from commit summary
Hi all,
Currently we are supposed to append the contributors name to the commit
summary when they are not committers of the project. The main reason for
doing this if I am not mistaken is to give some credit to those people.
I did like this practice in the beginning but I think it adds some small
overhead to all parties involved (committers and contributors).
The contributor quite often forgets to include the name in the end so the
burden to find and append the name goes to the committer.
In various cases, I've seen PRs ready to merge which were actually missing
the name at the end. What usually happens afterwards is one of the
following:
* the committer merges the PR without amending the name;
* the committer rebases the PR, amends the commit, and merges it;
* the committer asks the contributor to change the commit message;
I would prefer it if we could avoid this overhead by changing the commit
guidelines to not append the contributors name at the end.
GitHub does a great job giving credit to contributors. Moreover in most
cases the name appears in the log under the author tag so it is very easy
to exploit if we want to extract information and statistics.
What do you think?
Best,
Stamatis
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Vladimir Sitnikov <si...@gmail.com>.
Stamatis>I don't think someone is spending time going over the list of
contributors
I agree here. It should be automated in order to be workable.
The contributors link you suggest is nice.
Vladimir
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Stamatis Zampetakis <za...@gmail.com>.
Thanks everyone for the feedback, I will update the commit guidelines
accordingly.
For the release notes, I don't have a preference. I don't think someone is
spending time going over the list of contributors (apart maybe from PMCs
for inviting new committers :)).
If we want to include something then we could possibly include a GitHub
link showing the contributors for a certain period of time (from last
release date to current release date) such as the following:
https://github.com/apache/calcite/graphs/contributors?from=2021-06-04&to=2021-09-24
Best,
Stamatis
On Fri, Sep 24, 2021 at 5:48 AM Haisheng Yuan <hy...@apache.org> wrote:
> +1. That can reduce some work for contributors and committers.
>
> On 2021/09/23 22:14:11, Francis Chuang <fr...@apache.org> wrote:
> > +1 for not requiring the contributor's name in the commit message and
> > having "The following people contributed to this release" in the release
> > notes.
> >
> > On 24/09/2021 6:20 am, Alessandro Solimando wrote:
> > > Nowadays Github allows you to fetch that info very easily, I think
> it's a
> > > leftover from the past where the task proved to be harder.
> > >
> > > On Thu, 23 Sept 2021 at 22:09, Jacques Nadeau <ja...@apache.org>
> wrote:
> > >
> > >> I lead towards allowing people to use github if they want to know who
> > >> contributed what. Simple is better.
> > >>
> > >> On Thu, Sep 23, 2021 at 11:25 AM Vladimir Sitnikov <
> > >> sitnikov.vladimir@gmail.com> wrote:
> > >>
> > >>> I incline to "The following people contributed to this release"
> > >>> For instance, I like the way Gradle release notes are written:
> > >>> https://docs.gradle.org/7.2/release-notes.html
> > >>>
> > >>> The trick is that the author name does not convey the URL, so either
> we
> > >> use
> > >>> just names or we keep a contributor database.
> > >>>
> > >>> Vladimir
> > >>>
> > >>
> > >
> >
>
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Haisheng Yuan <hy...@apache.org>.
+1. That can reduce some work for contributors and committers.
On 2021/09/23 22:14:11, Francis Chuang <fr...@apache.org> wrote:
> +1 for not requiring the contributor's name in the commit message and
> having "The following people contributed to this release" in the release
> notes.
>
> On 24/09/2021 6:20 am, Alessandro Solimando wrote:
> > Nowadays Github allows you to fetch that info very easily, I think it's a
> > leftover from the past where the task proved to be harder.
> >
> > On Thu, 23 Sept 2021 at 22:09, Jacques Nadeau <ja...@apache.org> wrote:
> >
> >> I lead towards allowing people to use github if they want to know who
> >> contributed what. Simple is better.
> >>
> >> On Thu, Sep 23, 2021 at 11:25 AM Vladimir Sitnikov <
> >> sitnikov.vladimir@gmail.com> wrote:
> >>
> >>> I incline to "The following people contributed to this release"
> >>> For instance, I like the way Gradle release notes are written:
> >>> https://docs.gradle.org/7.2/release-notes.html
> >>>
> >>> The trick is that the author name does not convey the URL, so either we
> >> use
> >>> just names or we keep a contributor database.
> >>>
> >>> Vladimir
> >>>
> >>
> >
>
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Francis Chuang <fr...@apache.org>.
+1 for not requiring the contributor's name in the commit message and
having "The following people contributed to this release" in the release
notes.
On 24/09/2021 6:20 am, Alessandro Solimando wrote:
> Nowadays Github allows you to fetch that info very easily, I think it's a
> leftover from the past where the task proved to be harder.
>
> On Thu, 23 Sept 2021 at 22:09, Jacques Nadeau <ja...@apache.org> wrote:
>
>> I lead towards allowing people to use github if they want to know who
>> contributed what. Simple is better.
>>
>> On Thu, Sep 23, 2021 at 11:25 AM Vladimir Sitnikov <
>> sitnikov.vladimir@gmail.com> wrote:
>>
>>> I incline to "The following people contributed to this release"
>>> For instance, I like the way Gradle release notes are written:
>>> https://docs.gradle.org/7.2/release-notes.html
>>>
>>> The trick is that the author name does not convey the URL, so either we
>> use
>>> just names or we keep a contributor database.
>>>
>>> Vladimir
>>>
>>
>
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Alessandro Solimando <al...@gmail.com>.
Nowadays Github allows you to fetch that info very easily, I think it's a
leftover from the past where the task proved to be harder.
On Thu, 23 Sept 2021 at 22:09, Jacques Nadeau <ja...@apache.org> wrote:
> I lead towards allowing people to use github if they want to know who
> contributed what. Simple is better.
>
> On Thu, Sep 23, 2021 at 11:25 AM Vladimir Sitnikov <
> sitnikov.vladimir@gmail.com> wrote:
>
> > I incline to "The following people contributed to this release"
> > For instance, I like the way Gradle release notes are written:
> > https://docs.gradle.org/7.2/release-notes.html
> >
> > The trick is that the author name does not convey the URL, so either we
> use
> > just names or we keep a contributor database.
> >
> > Vladimir
> >
>
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Jacques Nadeau <ja...@apache.org>.
I lead towards allowing people to use github if they want to know who
contributed what. Simple is better.
On Thu, Sep 23, 2021 at 11:25 AM Vladimir Sitnikov <
sitnikov.vladimir@gmail.com> wrote:
> I incline to "The following people contributed to this release"
> For instance, I like the way Gradle release notes are written:
> https://docs.gradle.org/7.2/release-notes.html
>
> The trick is that the author name does not convey the URL, so either we use
> just names or we keep a contributor database.
>
> Vladimir
>
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Vladimir Sitnikov <si...@gmail.com>.
I incline to "The following people contributed to this release"
For instance, I like the way Gradle release notes are written:
https://docs.gradle.org/7.2/release-notes.html
The trick is that the author name does not convey the URL, so either we use
just names or we keep a contributor database.
Vladimir
回复： [DISCUSS] Remove contributors name from commit summary
Posted by 953396112 <13...@qq.com.INVALID>.
hi Julian:
I think you have a good idea. In the Calcite community, people can know who has made changes by browsing GitHub, the number of PR contributions and the activity of the community.And People can know their contributions in `https://github.com/apache/calcite/graphs/contributors`.
I hope the Calcite community will be better.
Xzh
------------------ 原始邮件 ------------------
发件人: "dev" <jhyde.apache@gmail.com>;
发送时间: 2021年9月23日(星期四) 晚上10:49
收件人: "dev"<dev@calcite.apache.org>;
主题: Re: [DISCUSS] Remove contributors name from commit summary
A separate but related question: should we give people credit for their contributions in the release notes? We could append a contributor’s name to each contribution (achieving a similar effect to today). Or we could generate a “The following people contributed to this release: …” paragraph per release. Or let people’s contributions speak for themselves (if you want to know who did a change, browse GitHub).
I lean towards the last of these, but I want to hear what others think. The goal, as ever, is to build a strong community.
Julian
> On Sep 23, 2021, at 7:37 AM, Julian Hyde <jhyde.apache@gmail.com> wrote:
>
> +1
>
>> On Sep 23, 2021, at 2:23 AM, Stamatis Zampetakis <zabetak@gmail.com> wrote:
>>
>> Hi all,
>>
>> Currently we are supposed to append the contributors name to the commit
>> summary when they are not committers of the project. The main reason for
>> doing this if I am not mistaken is to give some credit to those people.
>>
>> I did like this practice in the beginning but I think it adds some small
>> overhead to all parties involved (committers and contributors).
>>
>> The contributor quite often forgets to include the name in the end so the
>> burden to find and append the name goes to the committer.
>>
>> In various cases, I've seen PRs ready to merge which were actually missing
>> the name at the end. What usually happens afterwards is one of the
>> following:
>> * the committer merges the PR without amending the name;
>> * the committer rebases the PR, amends the commit, and merges it;
>> * the committer asks the contributor to change the commit message;
>>
>> I would prefer it if we could avoid this overhead by changing the commit
>> guidelines to not append the contributors name at the end.
>>
>> GitHub does a great job giving credit to contributors. Moreover in most
>> cases the name appears in the log under the author tag so it is very easy
>> to exploit if we want to extract information and statistics.
>>
>> What do you think?
>>
>> Best,
>> Stamatis
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Julian Hyde <jh...@gmail.com>.
A separate but related question: should we give people credit for their contributions in the release notes? We could append a contributor’s name to each contribution (achieving a similar effect to today). Or we could generate a “The following people contributed to this release: …” paragraph per release. Or let people’s contributions speak for themselves (if you want to know who did a change, browse GitHub).
I lean towards the last of these, but I want to hear what others think. The goal, as ever, is to build a strong community.
Julian
> On Sep 23, 2021, at 7:37 AM, Julian Hyde <jh...@gmail.com> wrote:
>
> +1
>
>> On Sep 23, 2021, at 2:23 AM, Stamatis Zampetakis <za...@gmail.com> wrote:
>>
>> Hi all,
>>
>> Currently we are supposed to append the contributors name to the commit
>> summary when they are not committers of the project. The main reason for
>> doing this if I am not mistaken is to give some credit to those people.
>>
>> I did like this practice in the beginning but I think it adds some small
>> overhead to all parties involved (committers and contributors).
>>
>> The contributor quite often forgets to include the name in the end so the
>> burden to find and append the name goes to the committer.
>>
>> In various cases, I've seen PRs ready to merge which were actually missing
>> the name at the end. What usually happens afterwards is one of the
>> following:
>> * the committer merges the PR without amending the name;
>> * the committer rebases the PR, amends the commit, and merges it;
>> * the committer asks the contributor to change the commit message;
>>
>> I would prefer it if we could avoid this overhead by changing the commit
>> guidelines to not append the contributors name at the end.
>>
>> GitHub does a great job giving credit to contributors. Moreover in most
>> cases the name appears in the log under the author tag so it is very easy
>> to exploit if we want to extract information and statistics.
>>
>> What do you think?
>>
>> Best,
>> Stamatis
Re: [DISCUSS] Remove contributors name from commit summary
Posted by Julian Hyde <jh...@gmail.com>.
+1
> On Sep 23, 2021, at 2:23 AM, Stamatis Zampetakis <za...@gmail.com> wrote:
>
> Hi all,
>
> Currently we are supposed to append the contributors name to the commit
> summary when they are not committers of the project. The main reason for
> doing this if I am not mistaken is to give some credit to those people.
>
> I did like this practice in the beginning but I think it adds some small
> overhead to all parties involved (committers and contributors).
>
> The contributor quite often forgets to include the name in the end so the
> burden to find and append the name goes to the committer.
>
> In various cases, I've seen PRs ready to merge which were actually missing
> the name at the end. What usually happens afterwards is one of the
> following:
> * the committer merges the PR without amending the name;
> * the committer rebases the PR, amends the commit, and merges it;
> * the committer asks the contributor to change the commit message;
>
> I would prefer it if we could avoid this overhead by changing the commit
> guidelines to not append the contributors name at the end.
>
> GitHub does a great job giving credit to contributors. Moreover in most
> cases the name appears in the log under the author tag so it is very easy
> to exploit if we want to extract information and statistics.
>
> What do you think?
>
> Best,
> Stamatis