You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@reef.apache.org by Byung-Gon Chun <bg...@gmail.com> on 2014/11/01 01:31:31 UTC
Re: Coding guidelines
Thanks, Markus.
Looks good.
It'd be good to add a guideline on comments --- class description, public
interface description, constructor description, etc.
When we have a release, we need to generate javadoc pages and link them at
our wiki.
Thanks.
-Gon
On Sat, Nov 1, 2014 at 2:36 AM, Markus Weimer <ma...@weimo.de> wrote:
> Hi,
>
> I created a wiki page with some initial thoughts on coding guidelines:
>
> https://cwiki.apache.org/confluence/display/REEF/Coding+Guidelines
>
> Please have a look and let's discuss what's missing / wrong in this thread.
>
> Thanks,
>
> Markus
>
--
Byung-Gon Chun
Re: Coding guidelines
Posted by Markus Weimer <ma...@weimo.de>.
I don't think we have one. Maybe we should track down the one from hadoop
and "borrow" it?
Markus
On Fri, Oct 31, 2014 at 6:17 PM, Brian Cho <ch...@gmail.com> wrote:
> Do we have a checkstyle configuration? If so we can link to it. If not we
> should mention that there's no current configuration (so devs don't get
> lost looking for one).
>
>
> Thanks,
>
> Brian
>
> On Sat, Nov 1, 2014 at 9:32 AM, Byung-Gon Chun <bg...@gmail.com> wrote:
>
> > Thanks, Markus.
> > Looks good.
> > It'd be good to add a guideline on comments --- class description, public
> > interface description, constructor description, etc.
> > When we have a release, we need to generate javadoc pages and link them
> at
> > our wiki.
> > Thanks.
> > -Gon
> > On Sat, Nov 1, 2014 at 2:36 AM, Markus Weimer <ma...@weimo.de> wrote:
> >> Hi,
> >>
> >> I created a wiki page with some initial thoughts on coding guidelines:
> >>
> >> https://cwiki.apache.org/confluence/display/REEF/Coding+Guidelines
> >>
> >> Please have a look and let's discuss what's missing / wrong in this
> thread.
> >>
> >> Thanks,
> >>
> >> Markus
> >>
> > --
> > Byung-Gon Chun
>
Re: Coding guidelines
Posted by Brian Cho <ch...@gmail.com>.
Do we have a checkstyle configuration? If so we can link to it. If not we should mention that there's no current configuration (so devs don't get lost looking for one).
Thanks,
Brian
On Sat, Nov 1, 2014 at 9:32 AM, Byung-Gon Chun <bg...@gmail.com> wrote:
> Thanks, Markus.
> Looks good.
> It'd be good to add a guideline on comments --- class description, public
> interface description, constructor description, etc.
> When we have a release, we need to generate javadoc pages and link them at
> our wiki.
> Thanks.
> -Gon
> On Sat, Nov 1, 2014 at 2:36 AM, Markus Weimer <ma...@weimo.de> wrote:
>> Hi,
>>
>> I created a wiki page with some initial thoughts on coding guidelines:
>>
>> https://cwiki.apache.org/confluence/display/REEF/Coding+Guidelines
>>
>> Please have a look and let's discuss what's missing / wrong in this thread.
>>
>> Thanks,
>>
>> Markus
>>
> --
> Byung-Gon Chun
Re: Coding guidelines
Posted by Markus Weimer <ma...@weimo.de>.
Hi,
feel free to put your thoughts on a comment guideline on there. I'll add a
page on "how to accept pull requests" later, as that is currently tribal
knowledge only practiced in Redmond :)
Markus
On Fri, Oct 31, 2014 at 5:31 PM, Byung-Gon Chun <bg...@gmail.com> wrote:
> Thanks, Markus.
>
> Looks good.
>
> It'd be good to add a guideline on comments --- class description, public
> interface description, constructor description, etc.
>
> When we have a release, we need to generate javadoc pages and link them at
> our wiki.
>
> Thanks.
> -Gon
>
> On Sat, Nov 1, 2014 at 2:36 AM, Markus Weimer <ma...@weimo.de> wrote:
>
> > Hi,
> >
> > I created a wiki page with some initial thoughts on coding guidelines:
> >
> > https://cwiki.apache.org/confluence/display/REEF/Coding+Guidelines
> >
> > Please have a look and let's discuss what's missing / wrong in this
> thread.
> >
> > Thanks,
> >
> > Markus
> >
>
>
>
> --
> Byung-Gon Chun
>