You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ignite.apache.org by Антон Калашников <ka...@yandex.ru> on 2018/02/14 08:23:38 UTC
Author in header of class
Hello Ignite Community!
My name is Anton. I joined to community some time ago and I want to contribute to Apache Ignite.
I would be want to make my first proposal. I noticed that Ignite don't have author description in header of classes unlike many other apache projects.
I propose to use javadoc tag @author in header of class when you created it and also add extra tag @author when you do many changes in this class.
Profits of this aproach, in my opinion:
1) You always know who has knowledge of this class unlike git annotate which are sensetive in refactoring, moving, etc.
2) It will highed responsibilty for code quality because nobody want to sign under bad code)
Example:
/**
* @author Anton Kalashnikov
* @author Other Author
*/
--
Best Regards,
Anton Kalashnikov
Re: Author in header of class
Posted by Ilya Lantukh <il...@gridgain.com>.
I agree with Vyacheslav and Anton Vinogradov. Using @author tag can be
misleading, Upsource will provide more up-to-date information.
On Wed, Feb 14, 2018 at 3:06 PM, Anton Vinogradov <av...@gridgain.com>
wrote:
> +1 to Upsource usage.
>
> Checked that code ownership provided by Upsource is correct.
>
> On Wed, Feb 14, 2018 at 2:22 PM, Vyacheslav Daradur <da...@gmail.com>
> wrote:
>
> > Dmitry,
> >
> > > - easy find reviewer and (Patch available queue),
> > > - find test author / mainteiner (MTCGA)>.
> > Upsource suggests reviewers based on changed classes maintainers when
> > we create pull request review.
> > Moreover, it shows all authors of each class in PR, with showing a
> > percentage of contributing.
> >
> > IMO using @author tag will be easy-to-use only with "little" classes,
> > because often hard to identify maintainer of "big" classes because of
> > great number of changes.
> >
> > Also, it will be preferable to send a review request to dev-list, if
> > maintainer retired and doesn't subscribe dev-list anymore.
> >
> > On Wed, Feb 14, 2018 at 1:38 PM, Dmitry Pavlov <dp...@gmail.com>
> > wrote:
> > > Hi Folks,
> > >
> > > Listing from git annotate are not informative because there are many
> > > contributors change same place of code.
> > >
> > > Code author information can help us to solve 2 issues for new community
> > > members:
> > > - easy find reviewer and (Patch available queue),
> > > - find test author / mainteiner (MTCGA).
> > >
> > > So I strongly like Anton K. proposal. It's pity that author tag is
> banned
> > > by Apache.
> > >
> > > Let's think how we can solve these 2 issues without author tag.
> > >
> > > One more point: IMHO we should remove selection of 2+ mainterners or
> > > underline one (default) contact point for area. Necessity to choise may
> > > confuse newcomer. One main (default) mainteiner will redirect review.
> > >
> > > Sincererely,
> > > Dmitriy Pavlov
> > >
> > > ср, 14 февр. 2018 г. в 13:10, Anton Vinogradov <
> avinogradov@gridgain.com
> > >:
> > >
> > >> Anton,
> > >>
> > >> All listed info can be gained from git history.
> > >>
> > >> On Wed, Feb 14, 2018 at 1:01 PM, Дмитрий Рябов <somefireone@gmail.com
> >
> > >> wrote:
> > >>
> > >> > For the first profit you should see maintainer table [1].
> > >> >
> > >> > [1]
> > >> > https://cwiki.apache.org/confluence/display/IGNITE/How+
> > >> > to+Contribute#HowtoContribute-ReviewProcessandMaintainers
> > >> >
> > >> > 2018-02-14 11:42 GMT+03:00 Vyacheslav Daradur <daradurvs@gmail.com
> >:
> > >> >
> > >> > > Hi Anton,
> > >> > >
> > >> > > Apache Ignite is licensed under the Apache License Version 2.0,
> > which
> > >> > > does not allow to use author tag in java code [1].
> > >> > >
> > >> > > [1] http://directory.apache.org/fortress/coding-standards.
> > >> > > html#classinterface-headers
> > >> > >
> > >> > > On Wed, Feb 14, 2018 at 11:23 AM, Антон Калашников <
> > kaa.dev@yandex.ru>
> > >> > > wrote:
> > >> > > > Hello Ignite Community!
> > >> > > >
> > >> > > > My name is Anton. I joined to community some time ago and I want
> > to
> > >> > > contribute to Apache Ignite.
> > >> > > >
> > >> > > > I would be want to make my first proposal. I noticed that Ignite
> > >> don't
> > >> > > have author description in header of classes unlike many other
> > apache
> > >> > > projects.
> > >> > > > I propose to use javadoc tag @author in header of class when you
> > >> > created
> > >> > > it and also add extra tag @author when you do many changes in
> this
> > >> > class.
> > >> > > >
> > >> > > > Profits of this aproach, in my opinion:
> > >> > > > 1) You always know who has knowledge of this class unlike git
> > >> annotate
> > >> > > which are sensetive in refactoring, moving, etc.
> > >> > > > 2) It will highed responsibilty for code quality because nobody
> > want
> > >> to
> > >> > > sign under bad code)
> > >> > > >
> > >> > > > Example:
> > >> > > > /**
> > >> > > > * @author Anton Kalashnikov
> > >> > > > * @author Other Author
> > >> > > > */
> > >> > > >
> > >> > > > --
> > >> > > > Best Regards,
> > >> > > > Anton Kalashnikov
> > >> > > >
> > >> > >
> > >> > >
> > >> > >
> > >> > > --
> > >> > > Best Regards, Vyacheslav D.
> > >> > >
> > >> >
> > >>
> >
> >
> >
> > --
> > Best Regards, Vyacheslav D.
> >
>
--
Best regards,
Ilya
Re: Author in header of class
Posted by Anton Vinogradov <av...@gridgain.com>.
+1 to Upsource usage.
Checked that code ownership provided by Upsource is correct.
On Wed, Feb 14, 2018 at 2:22 PM, Vyacheslav Daradur <da...@gmail.com>
wrote:
> Dmitry,
>
> > - easy find reviewer and (Patch available queue),
> > - find test author / mainteiner (MTCGA)>.
> Upsource suggests reviewers based on changed classes maintainers when
> we create pull request review.
> Moreover, it shows all authors of each class in PR, with showing a
> percentage of contributing.
>
> IMO using @author tag will be easy-to-use only with "little" classes,
> because often hard to identify maintainer of "big" classes because of
> great number of changes.
>
> Also, it will be preferable to send a review request to dev-list, if
> maintainer retired and doesn't subscribe dev-list anymore.
>
> On Wed, Feb 14, 2018 at 1:38 PM, Dmitry Pavlov <dp...@gmail.com>
> wrote:
> > Hi Folks,
> >
> > Listing from git annotate are not informative because there are many
> > contributors change same place of code.
> >
> > Code author information can help us to solve 2 issues for new community
> > members:
> > - easy find reviewer and (Patch available queue),
> > - find test author / mainteiner (MTCGA).
> >
> > So I strongly like Anton K. proposal. It's pity that author tag is banned
> > by Apache.
> >
> > Let's think how we can solve these 2 issues without author tag.
> >
> > One more point: IMHO we should remove selection of 2+ mainterners or
> > underline one (default) contact point for area. Necessity to choise may
> > confuse newcomer. One main (default) mainteiner will redirect review.
> >
> > Sincererely,
> > Dmitriy Pavlov
> >
> > ср, 14 февр. 2018 г. в 13:10, Anton Vinogradov <avinogradov@gridgain.com
> >:
> >
> >> Anton,
> >>
> >> All listed info can be gained from git history.
> >>
> >> On Wed, Feb 14, 2018 at 1:01 PM, Дмитрий Рябов <so...@gmail.com>
> >> wrote:
> >>
> >> > For the first profit you should see maintainer table [1].
> >> >
> >> > [1]
> >> > https://cwiki.apache.org/confluence/display/IGNITE/How+
> >> > to+Contribute#HowtoContribute-ReviewProcessandMaintainers
> >> >
> >> > 2018-02-14 11:42 GMT+03:00 Vyacheslav Daradur <da...@gmail.com>:
> >> >
> >> > > Hi Anton,
> >> > >
> >> > > Apache Ignite is licensed under the Apache License Version 2.0,
> which
> >> > > does not allow to use author tag in java code [1].
> >> > >
> >> > > [1] http://directory.apache.org/fortress/coding-standards.
> >> > > html#classinterface-headers
> >> > >
> >> > > On Wed, Feb 14, 2018 at 11:23 AM, Антон Калашников <
> kaa.dev@yandex.ru>
> >> > > wrote:
> >> > > > Hello Ignite Community!
> >> > > >
> >> > > > My name is Anton. I joined to community some time ago and I want
> to
> >> > > contribute to Apache Ignite.
> >> > > >
> >> > > > I would be want to make my first proposal. I noticed that Ignite
> >> don't
> >> > > have author description in header of classes unlike many other
> apache
> >> > > projects.
> >> > > > I propose to use javadoc tag @author in header of class when you
> >> > created
> >> > > it and also add extra tag @author when you do many changes in this
> >> > class.
> >> > > >
> >> > > > Profits of this aproach, in my opinion:
> >> > > > 1) You always know who has knowledge of this class unlike git
> >> annotate
> >> > > which are sensetive in refactoring, moving, etc.
> >> > > > 2) It will highed responsibilty for code quality because nobody
> want
> >> to
> >> > > sign under bad code)
> >> > > >
> >> > > > Example:
> >> > > > /**
> >> > > > * @author Anton Kalashnikov
> >> > > > * @author Other Author
> >> > > > */
> >> > > >
> >> > > > --
> >> > > > Best Regards,
> >> > > > Anton Kalashnikov
> >> > > >
> >> > >
> >> > >
> >> > >
> >> > > --
> >> > > Best Regards, Vyacheslav D.
> >> > >
> >> >
> >>
>
>
>
> --
> Best Regards, Vyacheslav D.
>
Re: Author in header of class
Posted by Vyacheslav Daradur <da...@gmail.com>.
Dmitry,
> - easy find reviewer and (Patch available queue),
> - find test author / mainteiner (MTCGA)>.
Upsource suggests reviewers based on changed classes maintainers when
we create pull request review.
Moreover, it shows all authors of each class in PR, with showing a
percentage of contributing.
IMO using @author tag will be easy-to-use only with "little" classes,
because often hard to identify maintainer of "big" classes because of
great number of changes.
Also, it will be preferable to send a review request to dev-list, if
maintainer retired and doesn't subscribe dev-list anymore.
On Wed, Feb 14, 2018 at 1:38 PM, Dmitry Pavlov <dp...@gmail.com> wrote:
> Hi Folks,
>
> Listing from git annotate are not informative because there are many
> contributors change same place of code.
>
> Code author information can help us to solve 2 issues for new community
> members:
> - easy find reviewer and (Patch available queue),
> - find test author / mainteiner (MTCGA).
>
> So I strongly like Anton K. proposal. It's pity that author tag is banned
> by Apache.
>
> Let's think how we can solve these 2 issues without author tag.
>
> One more point: IMHO we should remove selection of 2+ mainterners or
> underline one (default) contact point for area. Necessity to choise may
> confuse newcomer. One main (default) mainteiner will redirect review.
>
> Sincererely,
> Dmitriy Pavlov
>
> ср, 14 февр. 2018 г. в 13:10, Anton Vinogradov <av...@gridgain.com>:
>
>> Anton,
>>
>> All listed info can be gained from git history.
>>
>> On Wed, Feb 14, 2018 at 1:01 PM, Дмитрий Рябов <so...@gmail.com>
>> wrote:
>>
>> > For the first profit you should see maintainer table [1].
>> >
>> > [1]
>> > https://cwiki.apache.org/confluence/display/IGNITE/How+
>> > to+Contribute#HowtoContribute-ReviewProcessandMaintainers
>> >
>> > 2018-02-14 11:42 GMT+03:00 Vyacheslav Daradur <da...@gmail.com>:
>> >
>> > > Hi Anton,
>> > >
>> > > Apache Ignite is licensed under the Apache License Version 2.0, which
>> > > does not allow to use author tag in java code [1].
>> > >
>> > > [1] http://directory.apache.org/fortress/coding-standards.
>> > > html#classinterface-headers
>> > >
>> > > On Wed, Feb 14, 2018 at 11:23 AM, Антон Калашников <ka...@yandex.ru>
>> > > wrote:
>> > > > Hello Ignite Community!
>> > > >
>> > > > My name is Anton. I joined to community some time ago and I want to
>> > > contribute to Apache Ignite.
>> > > >
>> > > > I would be want to make my first proposal. I noticed that Ignite
>> don't
>> > > have author description in header of classes unlike many other apache
>> > > projects.
>> > > > I propose to use javadoc tag @author in header of class when you
>> > created
>> > > it and also add extra tag @author when you do many changes in this
>> > class.
>> > > >
>> > > > Profits of this aproach, in my opinion:
>> > > > 1) You always know who has knowledge of this class unlike git
>> annotate
>> > > which are sensetive in refactoring, moving, etc.
>> > > > 2) It will highed responsibilty for code quality because nobody want
>> to
>> > > sign under bad code)
>> > > >
>> > > > Example:
>> > > > /**
>> > > > * @author Anton Kalashnikov
>> > > > * @author Other Author
>> > > > */
>> > > >
>> > > > --
>> > > > Best Regards,
>> > > > Anton Kalashnikov
>> > > >
>> > >
>> > >
>> > >
>> > > --
>> > > Best Regards, Vyacheslav D.
>> > >
>> >
>>
--
Best Regards, Vyacheslav D.
Re: Author in header of class
Posted by Dmitry Pavlov <dp...@gmail.com>.
Hi Folks,
Listing from git annotate are not informative because there are many
contributors change same place of code.
Code author information can help us to solve 2 issues for new community
members:
- easy find reviewer and (Patch available queue),
- find test author / mainteiner (MTCGA).
So I strongly like Anton K. proposal. It's pity that author tag is banned
by Apache.
Let's think how we can solve these 2 issues without author tag.
One more point: IMHO we should remove selection of 2+ mainterners or
underline one (default) contact point for area. Necessity to choise may
confuse newcomer. One main (default) mainteiner will redirect review.
Sincererely,
Dmitriy Pavlov
ср, 14 февр. 2018 г. в 13:10, Anton Vinogradov <av...@gridgain.com>:
> Anton,
>
> All listed info can be gained from git history.
>
> On Wed, Feb 14, 2018 at 1:01 PM, Дмитрий Рябов <so...@gmail.com>
> wrote:
>
> > For the first profit you should see maintainer table [1].
> >
> > [1]
> > https://cwiki.apache.org/confluence/display/IGNITE/How+
> > to+Contribute#HowtoContribute-ReviewProcessandMaintainers
> >
> > 2018-02-14 11:42 GMT+03:00 Vyacheslav Daradur <da...@gmail.com>:
> >
> > > Hi Anton,
> > >
> > > Apache Ignite is licensed under the Apache License Version 2.0, which
> > > does not allow to use author tag in java code [1].
> > >
> > > [1] http://directory.apache.org/fortress/coding-standards.
> > > html#classinterface-headers
> > >
> > > On Wed, Feb 14, 2018 at 11:23 AM, Антон Калашников <ka...@yandex.ru>
> > > wrote:
> > > > Hello Ignite Community!
> > > >
> > > > My name is Anton. I joined to community some time ago and I want to
> > > contribute to Apache Ignite.
> > > >
> > > > I would be want to make my first proposal. I noticed that Ignite
> don't
> > > have author description in header of classes unlike many other apache
> > > projects.
> > > > I propose to use javadoc tag @author in header of class when you
> > created
> > > it and also add extra tag @author when you do many changes in this
> > class.
> > > >
> > > > Profits of this aproach, in my opinion:
> > > > 1) You always know who has knowledge of this class unlike git
> annotate
> > > which are sensetive in refactoring, moving, etc.
> > > > 2) It will highed responsibilty for code quality because nobody want
> to
> > > sign under bad code)
> > > >
> > > > Example:
> > > > /**
> > > > * @author Anton Kalashnikov
> > > > * @author Other Author
> > > > */
> > > >
> > > > --
> > > > Best Regards,
> > > > Anton Kalashnikov
> > > >
> > >
> > >
> > >
> > > --
> > > Best Regards, Vyacheslav D.
> > >
> >
>
Re: Author in header of class
Posted by Anton Vinogradov <av...@gridgain.com>.
Anton,
All listed info can be gained from git history.
On Wed, Feb 14, 2018 at 1:01 PM, Дмитрий Рябов <so...@gmail.com>
wrote:
> For the first profit you should see maintainer table [1].
>
> [1]
> https://cwiki.apache.org/confluence/display/IGNITE/How+
> to+Contribute#HowtoContribute-ReviewProcessandMaintainers
>
> 2018-02-14 11:42 GMT+03:00 Vyacheslav Daradur <da...@gmail.com>:
>
> > Hi Anton,
> >
> > Apache Ignite is licensed under the Apache License Version 2.0, which
> > does not allow to use author tag in java code [1].
> >
> > [1] http://directory.apache.org/fortress/coding-standards.
> > html#classinterface-headers
> >
> > On Wed, Feb 14, 2018 at 11:23 AM, Антон Калашников <ka...@yandex.ru>
> > wrote:
> > > Hello Ignite Community!
> > >
> > > My name is Anton. I joined to community some time ago and I want to
> > contribute to Apache Ignite.
> > >
> > > I would be want to make my first proposal. I noticed that Ignite don't
> > have author description in header of classes unlike many other apache
> > projects.
> > > I propose to use javadoc tag @author in header of class when you
> created
> > it and also add extra tag @author when you do many changes in this
> class.
> > >
> > > Profits of this aproach, in my opinion:
> > > 1) You always know who has knowledge of this class unlike git annotate
> > which are sensetive in refactoring, moving, etc.
> > > 2) It will highed responsibilty for code quality because nobody want to
> > sign under bad code)
> > >
> > > Example:
> > > /**
> > > * @author Anton Kalashnikov
> > > * @author Other Author
> > > */
> > >
> > > --
> > > Best Regards,
> > > Anton Kalashnikov
> > >
> >
> >
> >
> > --
> > Best Regards, Vyacheslav D.
> >
>
Re: Author in header of class
Posted by Дмитрий Рябов <so...@gmail.com>.
For the first profit you should see maintainer table [1].
[1]
https://cwiki.apache.org/confluence/display/IGNITE/How+to+Contribute#HowtoContribute-ReviewProcessandMaintainers
2018-02-14 11:42 GMT+03:00 Vyacheslav Daradur <da...@gmail.com>:
> Hi Anton,
>
> Apache Ignite is licensed under the Apache License Version 2.0, which
> does not allow to use author tag in java code [1].
>
> [1] http://directory.apache.org/fortress/coding-standards.
> html#classinterface-headers
>
> On Wed, Feb 14, 2018 at 11:23 AM, Антон Калашников <ka...@yandex.ru>
> wrote:
> > Hello Ignite Community!
> >
> > My name is Anton. I joined to community some time ago and I want to
> contribute to Apache Ignite.
> >
> > I would be want to make my first proposal. I noticed that Ignite don't
> have author description in header of classes unlike many other apache
> projects.
> > I propose to use javadoc tag @author in header of class when you created
> it and also add extra tag @author when you do many changes in this class.
> >
> > Profits of this aproach, in my opinion:
> > 1) You always know who has knowledge of this class unlike git annotate
> which are sensetive in refactoring, moving, etc.
> > 2) It will highed responsibilty for code quality because nobody want to
> sign under bad code)
> >
> > Example:
> > /**
> > * @author Anton Kalashnikov
> > * @author Other Author
> > */
> >
> > --
> > Best Regards,
> > Anton Kalashnikov
> >
>
>
>
> --
> Best Regards, Vyacheslav D.
>
Re: Author in header of class
Posted by Vyacheslav Daradur <da...@gmail.com>.
Hi Anton,
Apache Ignite is licensed under the Apache License Version 2.0, which
does not allow to use author tag in java code [1].
[1] http://directory.apache.org/fortress/coding-standards.html#classinterface-headers
On Wed, Feb 14, 2018 at 11:23 AM, Антон Калашников <ka...@yandex.ru> wrote:
> Hello Ignite Community!
>
> My name is Anton. I joined to community some time ago and I want to contribute to Apache Ignite.
>
> I would be want to make my first proposal. I noticed that Ignite don't have author description in header of classes unlike many other apache projects.
> I propose to use javadoc tag @author in header of class when you created it and also add extra tag @author when you do many changes in this class.
>
> Profits of this aproach, in my opinion:
> 1) You always know who has knowledge of this class unlike git annotate which are sensetive in refactoring, moving, etc.
> 2) It will highed responsibilty for code quality because nobody want to sign under bad code)
>
> Example:
> /**
> * @author Anton Kalashnikov
> * @author Other Author
> */
>
> --
> Best Regards,
> Anton Kalashnikov
>
--
Best Regards, Vyacheslav D.