Accepting contributions with Javadoc comments

[Roman Shtykh <rs...@yahoo.com.INVALID>]

Folks,
The current codebase has too few comments and not so many unit tests, and therefore it is pretty hard to understand the intentions of developers on their code (and figure out if a fix/improvement is needed, and so on).
I realize we cannot start commenting on all the code now, but how about accepting pull requests only if all newly-introduced or significantly modified public methods and classes have informative Javadoc comments, in addition to unit tests, where applicable?Writing comments on the code you understand is pretty easy, and it saves some time to others.
Roman

Re: Accepting contributions with Javadoc comments

[Luke Han <lu...@gmail.com>]

+1 to have more documentation.


Best Regards!
---------------------

Luke Han

On Wed, Feb 22, 2017 at 4:32 PM, chandresh pancholi <
chandreshpancholi007@gmail.com> wrote:

> +1
> Completely agree with Roman, Sometimes it's hard to understand the
> functionality of methods in codebase.
>
>
>
> On Wed, Feb 22, 2017 at 1:48 PM, Roman Shtykh <rs...@yahoo.com.invalid>
> wrote:
>
> > Folks,
> > The current codebase has too few comments and not so many unit tests, and
> > therefore it is pretty hard to understand the intentions of developers on
> > their code (and figure out if a fix/improvement is needed, and so on).
> > I realize we cannot start commenting on all the code now, but how about
> > accepting pull requests only if all newly-introduced or significantly
> > modified public methods and classes have informative Javadoc comments, in
> > addition to unit tests, where applicable?Writing comments on the code you
> > understand is pretty easy, and it saves some time to others.
> > Roman
> >
>
>
>
> --
> Chandresh Pancholi
> Senior Software Engineer
> Flipkart.com
> Email-id:chandresh.pancholi@flipkart.com
> Contact:08951803660
>

Re: Accepting contributions with Javadoc comments

[chandresh pancholi <ch...@gmail.com>]

+1
Completely agree with Roman, Sometimes it's hard to understand the
functionality of methods in codebase.



On Wed, Feb 22, 2017 at 1:48 PM, Roman Shtykh <rs...@yahoo.com.invalid>
wrote:

> Folks,
> The current codebase has too few comments and not so many unit tests, and
> therefore it is pretty hard to understand the intentions of developers on
> their code (and figure out if a fix/improvement is needed, and so on).
> I realize we cannot start commenting on all the code now, but how about
> accepting pull requests only if all newly-introduced or significantly
> modified public methods and classes have informative Javadoc comments, in
> addition to unit tests, where applicable?Writing comments on the code you
> understand is pretty easy, and it saves some time to others.
> Roman
>



-- 
Chandresh Pancholi
Senior Software Engineer
Flipkart.com
Email-id:chandresh.pancholi@flipkart.com
Contact:08951803660

Re: Accepting contributions with Javadoc comments

[Willem Jiang <wi...@gmail.com>]

I think we need to set up a fast track to accept the PR of adding Javadoc
or other comments.
As those change would break the CI build and it should be safe if we review
the comments after merging.


Willem Jiang

Blog: http://willemjiang.blogspot.com (English)
          http://jnn.iteye.com  (Chinese)
Twitter: willemjiang
Weibo: 姜宁willem

On Wed, Feb 22, 2017 at 4:18 PM, Roman Shtykh <rs...@yahoo.com.invalid>
wrote:

> Folks,
> The current codebase has too few comments and not so many unit tests, and
> therefore it is pretty hard to understand the intentions of developers on
> their code (and figure out if a fix/improvement is needed, and so on).
> I realize we cannot start commenting on all the code now, but how about
> accepting pull requests only if all newly-introduced or significantly
> modified public methods and classes have informative Javadoc comments, in
> addition to unit tests, where applicable?Writing comments on the code you
> understand is pretty easy, and it saves some time to others.
> Roman
>