You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@apex.apache.org by Chandni Singh <ch...@datatorrent.com> on 2015/12/15 23:02:23 UTC
Code style guidelines - any volunteers?
Hi,
https://malhar.atlassian.net/browse/APEX-180
Will anyone like to take up this JIRA?
We have increasing contributions and it will be helpful if we have style
guideline in place and integrated with
http://apex.incubator.apache.org/contributing.html
I can help out as well.
Thanks,
Chandni
Re: Code style guidelines - any volunteers?
Posted by Thomas Weise <th...@datatorrent.com>.
Thanks!
On Fri, Dec 18, 2015 at 12:32 PM, Chandni Singh <ch...@datatorrent.com>
wrote:
> https://github.com/apache/incubator-apex-site/pull/9
>
> On Wed, Dec 16, 2015 at 10:56 AM, Chandni Singh <ch...@datatorrent.com>
> wrote:
>
> > I assigned the ticket to me.
> >
> > Chandni
> >
> > On Wed, Dec 16, 2015 at 10:47 AM, Thomas Weise <th...@datatorrent.com>
> > wrote:
> >
> >> Chandni,
> >>
> >> Can you add a few pointers to:
> >>
> >> http://apex.incubator.apache.org/contributing.html
> >>
> >> This way contributors will be aware of this before raising the pull
> >> request.
> >>
> >> Thanks
> >>
> >> On Tue, Dec 15, 2015 at 4:16 PM, Chandni Singh <chandni@datatorrent.com
> >
> >> wrote:
> >>
> >> > Forwarding the correct link to Jira for comments
> >> > https://issues.apache.org/jira/browse/APEXCORE-180
> >> >
> >> > On Tue, Dec 15, 2015 at 2:55 PM, Chandni Singh <
> chandni@datatorrent.com
> >> >
> >> > wrote:
> >> >
> >> > > Sorry mailed before I completed the mail.
> >> > >
> >> > > These are some examples that I had in mind:
> >> > >
> >>
> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> >> > > https://flink.apache.org/contribute-code.html#code-style
> >> > > We have more rules than these projects though. So there needs to be
> an
> >> > > additional section of where to find settings for each IDE and how to
> >> > apply
> >> > > them.
> >> > >
> >> > > Chandni
> >> > >
> >> > > On Tue, Dec 15, 2015 at 2:30 PM, Chandni Singh <
> >> chandni@datatorrent.com>
> >> > > wrote:
> >> > >
> >> > >> These are some examples :
> >> > >>
> >> >
> >>
> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> >> > >> https://flink.apache.org/contribute-code.html#code-style
> >> > >>
> >> > >> Chandni
> >> > >>
> >> > >> On Tue, Dec 15, 2015 at 2:22 PM, Munagala Ramanath <
> >> ram@datatorrent.com
> >> > >
> >> > >> wrote:
> >> > >>
> >> > >>> Hi Chandni,
> >> > >>>
> >> > >>> Wanted to get some more info about what you're looking for here.
> >> > >>> Chetan sent out email July 10 with this text:
> >> > >>>
> >> > >>> --------------------------------
> >> > >>> Guys,
> >> > >>>
> >> > >>> Knowing that we all follow different coding conventions and we are
> >> now
> >> > >>> going to make a big announcement about Apex, it's a good idea to
> >> define
> >> > >>> code
> >> > >>> formatting standards which not only we will follow but ask even
> the
> >> > >>> outside
> >> > >>> contributors to follow.
> >> > >>>
> >> > >>> At the high level, what the common coding standard will give us
> >> are 2
> >> > >>> things:
> >> > >>>
> >> > >>> 1. A warm feeling that code style is consistent.
> >> > >>> 2. Will not cause unnecessary change sets.
> >> > >>>
> >> > >>> Given that there are a bunch of different styles, please read up
> >> about
> >> > >>> those and make up your mind on which style you prefer. The link on
> >> > >>> Wikipedia is concise and short:
> >> > >>> http://en.wikipedia.org/wiki/Indent_style
> >> > >>> to help you get started.
> >> > >>>
> >> > >>> I also have a short survey for you to vote. Please vote for your
> >> style.
> >> > >>> If
> >> > >>> there is an absolute majority for a specific coding style, we will
> >> go
> >> > >>> with
> >> > >>> it. In other cases it will help in developing consensus.
> >> > >>>
> >> > >>> https://www.surveymonkey.com/r/QQGCFW6
> >> > >>>
> >> > >>> --------------------------------
> >> > >>>
> >> > >>> and there were some followup messages. Do we want to pick one of
> the
> >> > >>> existing guides like:
> >> > >>>
> >> > >>>
> >> >
> >>
> http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
> >> > >>> http://google.github.io/styleguide/javaguide.html
> >> > >>>
> >> > >>> or are we looking to write an entirely new one for Apex based on
> the
> >> > >>> existing code base ?
> >> > >>> If we write a new one, do we want to put it in the code repo or on
> >> docs
> >> > >>> repo ?
> >> > >>>
> >> > >>> I'll post a followup to the list once I have a better idea of what
> >> > you're
> >> > >>> thinking.
> >> > >>>
> >> > >>> Ram
> >> > >>>
> >> > >>> On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <
> >> > chandni@datatorrent.com>
> >> > >>> wrote:
> >> > >>>
> >> > >>> > Hi,
> >> > >>> >
> >> > >>> > https://malhar.atlassian.net/browse/APEX-180
> >> > >>> >
> >> > >>> > Will anyone like to take up this JIRA?
> >> > >>> >
> >> > >>> > We have increasing contributions and it will be helpful if we
> have
> >> > >>> style
> >> > >>> > guideline in place and integrated with
> >> > >>> > http://apex.incubator.apache.org/contributing.html
> >> > >>> >
> >> > >>> > I can help out as well.
> >> > >>> >
> >> > >>> > Thanks,
> >> > >>> > Chandni
> >> > >>> >
> >> > >>>
> >> > >>
> >> > >>
> >> > >
> >> >
> >>
> >
> >
>
Re: Code style guidelines - any volunteers?
Posted by Chandni Singh <ch...@datatorrent.com>.
https://github.com/apache/incubator-apex-site/pull/9
On Wed, Dec 16, 2015 at 10:56 AM, Chandni Singh <ch...@datatorrent.com>
wrote:
> I assigned the ticket to me.
>
> Chandni
>
> On Wed, Dec 16, 2015 at 10:47 AM, Thomas Weise <th...@datatorrent.com>
> wrote:
>
>> Chandni,
>>
>> Can you add a few pointers to:
>>
>> http://apex.incubator.apache.org/contributing.html
>>
>> This way contributors will be aware of this before raising the pull
>> request.
>>
>> Thanks
>>
>> On Tue, Dec 15, 2015 at 4:16 PM, Chandni Singh <ch...@datatorrent.com>
>> wrote:
>>
>> > Forwarding the correct link to Jira for comments
>> > https://issues.apache.org/jira/browse/APEXCORE-180
>> >
>> > On Tue, Dec 15, 2015 at 2:55 PM, Chandni Singh <chandni@datatorrent.com
>> >
>> > wrote:
>> >
>> > > Sorry mailed before I completed the mail.
>> > >
>> > > These are some examples that I had in mind:
>> > >
>> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
>> > > https://flink.apache.org/contribute-code.html#code-style
>> > > We have more rules than these projects though. So there needs to be an
>> > > additional section of where to find settings for each IDE and how to
>> > apply
>> > > them.
>> > >
>> > > Chandni
>> > >
>> > > On Tue, Dec 15, 2015 at 2:30 PM, Chandni Singh <
>> chandni@datatorrent.com>
>> > > wrote:
>> > >
>> > >> These are some examples :
>> > >>
>> >
>> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
>> > >> https://flink.apache.org/contribute-code.html#code-style
>> > >>
>> > >> Chandni
>> > >>
>> > >> On Tue, Dec 15, 2015 at 2:22 PM, Munagala Ramanath <
>> ram@datatorrent.com
>> > >
>> > >> wrote:
>> > >>
>> > >>> Hi Chandni,
>> > >>>
>> > >>> Wanted to get some more info about what you're looking for here.
>> > >>> Chetan sent out email July 10 with this text:
>> > >>>
>> > >>> --------------------------------
>> > >>> Guys,
>> > >>>
>> > >>> Knowing that we all follow different coding conventions and we are
>> now
>> > >>> going to make a big announcement about Apex, it's a good idea to
>> define
>> > >>> code
>> > >>> formatting standards which not only we will follow but ask even the
>> > >>> outside
>> > >>> contributors to follow.
>> > >>>
>> > >>> At the high level, what the common coding standard will give us
>> are 2
>> > >>> things:
>> > >>>
>> > >>> 1. A warm feeling that code style is consistent.
>> > >>> 2. Will not cause unnecessary change sets.
>> > >>>
>> > >>> Given that there are a bunch of different styles, please read up
>> about
>> > >>> those and make up your mind on which style you prefer. The link on
>> > >>> Wikipedia is concise and short:
>> > >>> http://en.wikipedia.org/wiki/Indent_style
>> > >>> to help you get started.
>> > >>>
>> > >>> I also have a short survey for you to vote. Please vote for your
>> style.
>> > >>> If
>> > >>> there is an absolute majority for a specific coding style, we will
>> go
>> > >>> with
>> > >>> it. In other cases it will help in developing consensus.
>> > >>>
>> > >>> https://www.surveymonkey.com/r/QQGCFW6
>> > >>>
>> > >>> --------------------------------
>> > >>>
>> > >>> and there were some followup messages. Do we want to pick one of the
>> > >>> existing guides like:
>> > >>>
>> > >>>
>> >
>> http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
>> > >>> http://google.github.io/styleguide/javaguide.html
>> > >>>
>> > >>> or are we looking to write an entirely new one for Apex based on the
>> > >>> existing code base ?
>> > >>> If we write a new one, do we want to put it in the code repo or on
>> docs
>> > >>> repo ?
>> > >>>
>> > >>> I'll post a followup to the list once I have a better idea of what
>> > you're
>> > >>> thinking.
>> > >>>
>> > >>> Ram
>> > >>>
>> > >>> On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <
>> > chandni@datatorrent.com>
>> > >>> wrote:
>> > >>>
>> > >>> > Hi,
>> > >>> >
>> > >>> > https://malhar.atlassian.net/browse/APEX-180
>> > >>> >
>> > >>> > Will anyone like to take up this JIRA?
>> > >>> >
>> > >>> > We have increasing contributions and it will be helpful if we have
>> > >>> style
>> > >>> > guideline in place and integrated with
>> > >>> > http://apex.incubator.apache.org/contributing.html
>> > >>> >
>> > >>> > I can help out as well.
>> > >>> >
>> > >>> > Thanks,
>> > >>> > Chandni
>> > >>> >
>> > >>>
>> > >>
>> > >>
>> > >
>> >
>>
>
>
Re: Code style guidelines - any volunteers?
Posted by Chandni Singh <ch...@datatorrent.com>.
I assigned the ticket to me.
Chandni
On Wed, Dec 16, 2015 at 10:47 AM, Thomas Weise <th...@datatorrent.com>
wrote:
> Chandni,
>
> Can you add a few pointers to:
>
> http://apex.incubator.apache.org/contributing.html
>
> This way contributors will be aware of this before raising the pull
> request.
>
> Thanks
>
> On Tue, Dec 15, 2015 at 4:16 PM, Chandni Singh <ch...@datatorrent.com>
> wrote:
>
> > Forwarding the correct link to Jira for comments
> > https://issues.apache.org/jira/browse/APEXCORE-180
> >
> > On Tue, Dec 15, 2015 at 2:55 PM, Chandni Singh <ch...@datatorrent.com>
> > wrote:
> >
> > > Sorry mailed before I completed the mail.
> > >
> > > These are some examples that I had in mind:
> > >
> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> > > https://flink.apache.org/contribute-code.html#code-style
> > > We have more rules than these projects though. So there needs to be an
> > > additional section of where to find settings for each IDE and how to
> > apply
> > > them.
> > >
> > > Chandni
> > >
> > > On Tue, Dec 15, 2015 at 2:30 PM, Chandni Singh <
> chandni@datatorrent.com>
> > > wrote:
> > >
> > >> These are some examples :
> > >>
> > https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> > >> https://flink.apache.org/contribute-code.html#code-style
> > >>
> > >> Chandni
> > >>
> > >> On Tue, Dec 15, 2015 at 2:22 PM, Munagala Ramanath <
> ram@datatorrent.com
> > >
> > >> wrote:
> > >>
> > >>> Hi Chandni,
> > >>>
> > >>> Wanted to get some more info about what you're looking for here.
> > >>> Chetan sent out email July 10 with this text:
> > >>>
> > >>> --------------------------------
> > >>> Guys,
> > >>>
> > >>> Knowing that we all follow different coding conventions and we are
> now
> > >>> going to make a big announcement about Apex, it's a good idea to
> define
> > >>> code
> > >>> formatting standards which not only we will follow but ask even the
> > >>> outside
> > >>> contributors to follow.
> > >>>
> > >>> At the high level, what the common coding standard will give us are
> 2
> > >>> things:
> > >>>
> > >>> 1. A warm feeling that code style is consistent.
> > >>> 2. Will not cause unnecessary change sets.
> > >>>
> > >>> Given that there are a bunch of different styles, please read up
> about
> > >>> those and make up your mind on which style you prefer. The link on
> > >>> Wikipedia is concise and short:
> > >>> http://en.wikipedia.org/wiki/Indent_style
> > >>> to help you get started.
> > >>>
> > >>> I also have a short survey for you to vote. Please vote for your
> style.
> > >>> If
> > >>> there is an absolute majority for a specific coding style, we will go
> > >>> with
> > >>> it. In other cases it will help in developing consensus.
> > >>>
> > >>> https://www.surveymonkey.com/r/QQGCFW6
> > >>>
> > >>> --------------------------------
> > >>>
> > >>> and there were some followup messages. Do we want to pick one of the
> > >>> existing guides like:
> > >>>
> > >>>
> >
> http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
> > >>> http://google.github.io/styleguide/javaguide.html
> > >>>
> > >>> or are we looking to write an entirely new one for Apex based on the
> > >>> existing code base ?
> > >>> If we write a new one, do we want to put it in the code repo or on
> docs
> > >>> repo ?
> > >>>
> > >>> I'll post a followup to the list once I have a better idea of what
> > you're
> > >>> thinking.
> > >>>
> > >>> Ram
> > >>>
> > >>> On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <
> > chandni@datatorrent.com>
> > >>> wrote:
> > >>>
> > >>> > Hi,
> > >>> >
> > >>> > https://malhar.atlassian.net/browse/APEX-180
> > >>> >
> > >>> > Will anyone like to take up this JIRA?
> > >>> >
> > >>> > We have increasing contributions and it will be helpful if we have
> > >>> style
> > >>> > guideline in place and integrated with
> > >>> > http://apex.incubator.apache.org/contributing.html
> > >>> >
> > >>> > I can help out as well.
> > >>> >
> > >>> > Thanks,
> > >>> > Chandni
> > >>> >
> > >>>
> > >>
> > >>
> > >
> >
>
Re: Code style guidelines - any volunteers?
Posted by Thomas Weise <th...@datatorrent.com>.
Chandni,
Can you add a few pointers to:
http://apex.incubator.apache.org/contributing.html
This way contributors will be aware of this before raising the pull request.
Thanks
On Tue, Dec 15, 2015 at 4:16 PM, Chandni Singh <ch...@datatorrent.com>
wrote:
> Forwarding the correct link to Jira for comments
> https://issues.apache.org/jira/browse/APEXCORE-180
>
> On Tue, Dec 15, 2015 at 2:55 PM, Chandni Singh <ch...@datatorrent.com>
> wrote:
>
> > Sorry mailed before I completed the mail.
> >
> > These are some examples that I had in mind:
> > https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> > https://flink.apache.org/contribute-code.html#code-style
> > We have more rules than these projects though. So there needs to be an
> > additional section of where to find settings for each IDE and how to
> apply
> > them.
> >
> > Chandni
> >
> > On Tue, Dec 15, 2015 at 2:30 PM, Chandni Singh <ch...@datatorrent.com>
> > wrote:
> >
> >> These are some examples :
> >>
> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> >> https://flink.apache.org/contribute-code.html#code-style
> >>
> >> Chandni
> >>
> >> On Tue, Dec 15, 2015 at 2:22 PM, Munagala Ramanath <ram@datatorrent.com
> >
> >> wrote:
> >>
> >>> Hi Chandni,
> >>>
> >>> Wanted to get some more info about what you're looking for here.
> >>> Chetan sent out email July 10 with this text:
> >>>
> >>> --------------------------------
> >>> Guys,
> >>>
> >>> Knowing that we all follow different coding conventions and we are now
> >>> going to make a big announcement about Apex, it's a good idea to define
> >>> code
> >>> formatting standards which not only we will follow but ask even the
> >>> outside
> >>> contributors to follow.
> >>>
> >>> At the high level, what the common coding standard will give us are 2
> >>> things:
> >>>
> >>> 1. A warm feeling that code style is consistent.
> >>> 2. Will not cause unnecessary change sets.
> >>>
> >>> Given that there are a bunch of different styles, please read up about
> >>> those and make up your mind on which style you prefer. The link on
> >>> Wikipedia is concise and short:
> >>> http://en.wikipedia.org/wiki/Indent_style
> >>> to help you get started.
> >>>
> >>> I also have a short survey for you to vote. Please vote for your style.
> >>> If
> >>> there is an absolute majority for a specific coding style, we will go
> >>> with
> >>> it. In other cases it will help in developing consensus.
> >>>
> >>> https://www.surveymonkey.com/r/QQGCFW6
> >>>
> >>> --------------------------------
> >>>
> >>> and there were some followup messages. Do we want to pick one of the
> >>> existing guides like:
> >>>
> >>>
> http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
> >>> http://google.github.io/styleguide/javaguide.html
> >>>
> >>> or are we looking to write an entirely new one for Apex based on the
> >>> existing code base ?
> >>> If we write a new one, do we want to put it in the code repo or on docs
> >>> repo ?
> >>>
> >>> I'll post a followup to the list once I have a better idea of what
> you're
> >>> thinking.
> >>>
> >>> Ram
> >>>
> >>> On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <
> chandni@datatorrent.com>
> >>> wrote:
> >>>
> >>> > Hi,
> >>> >
> >>> > https://malhar.atlassian.net/browse/APEX-180
> >>> >
> >>> > Will anyone like to take up this JIRA?
> >>> >
> >>> > We have increasing contributions and it will be helpful if we have
> >>> style
> >>> > guideline in place and integrated with
> >>> > http://apex.incubator.apache.org/contributing.html
> >>> >
> >>> > I can help out as well.
> >>> >
> >>> > Thanks,
> >>> > Chandni
> >>> >
> >>>
> >>
> >>
> >
>
Re: Code style guidelines - any volunteers?
Posted by Chandni Singh <ch...@datatorrent.com>.
Forwarding the correct link to Jira for comments
https://issues.apache.org/jira/browse/APEXCORE-180
On Tue, Dec 15, 2015 at 2:55 PM, Chandni Singh <ch...@datatorrent.com>
wrote:
> Sorry mailed before I completed the mail.
>
> These are some examples that I had in mind:
> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> https://flink.apache.org/contribute-code.html#code-style
> We have more rules than these projects though. So there needs to be an
> additional section of where to find settings for each IDE and how to apply
> them.
>
> Chandni
>
> On Tue, Dec 15, 2015 at 2:30 PM, Chandni Singh <ch...@datatorrent.com>
> wrote:
>
>> These are some examples :
>> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
>> https://flink.apache.org/contribute-code.html#code-style
>>
>> Chandni
>>
>> On Tue, Dec 15, 2015 at 2:22 PM, Munagala Ramanath <ra...@datatorrent.com>
>> wrote:
>>
>>> Hi Chandni,
>>>
>>> Wanted to get some more info about what you're looking for here.
>>> Chetan sent out email July 10 with this text:
>>>
>>> --------------------------------
>>> Guys,
>>>
>>> Knowing that we all follow different coding conventions and we are now
>>> going to make a big announcement about Apex, it's a good idea to define
>>> code
>>> formatting standards which not only we will follow but ask even the
>>> outside
>>> contributors to follow.
>>>
>>> At the high level, what the common coding standard will give us are 2
>>> things:
>>>
>>> 1. A warm feeling that code style is consistent.
>>> 2. Will not cause unnecessary change sets.
>>>
>>> Given that there are a bunch of different styles, please read up about
>>> those and make up your mind on which style you prefer. The link on
>>> Wikipedia is concise and short:
>>> http://en.wikipedia.org/wiki/Indent_style
>>> to help you get started.
>>>
>>> I also have a short survey for you to vote. Please vote for your style.
>>> If
>>> there is an absolute majority for a specific coding style, we will go
>>> with
>>> it. In other cases it will help in developing consensus.
>>>
>>> https://www.surveymonkey.com/r/QQGCFW6
>>>
>>> --------------------------------
>>>
>>> and there were some followup messages. Do we want to pick one of the
>>> existing guides like:
>>>
>>> http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
>>> http://google.github.io/styleguide/javaguide.html
>>>
>>> or are we looking to write an entirely new one for Apex based on the
>>> existing code base ?
>>> If we write a new one, do we want to put it in the code repo or on docs
>>> repo ?
>>>
>>> I'll post a followup to the list once I have a better idea of what you're
>>> thinking.
>>>
>>> Ram
>>>
>>> On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <ch...@datatorrent.com>
>>> wrote:
>>>
>>> > Hi,
>>> >
>>> > https://malhar.atlassian.net/browse/APEX-180
>>> >
>>> > Will anyone like to take up this JIRA?
>>> >
>>> > We have increasing contributions and it will be helpful if we have
>>> style
>>> > guideline in place and integrated with
>>> > http://apex.incubator.apache.org/contributing.html
>>> >
>>> > I can help out as well.
>>> >
>>> > Thanks,
>>> > Chandni
>>> >
>>>
>>
>>
>
Re: Code style guidelines - any volunteers?
Posted by Chandni Singh <ch...@datatorrent.com>.
Sorry mailed before I completed the mail.
These are some examples that I had in mind:
https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
https://flink.apache.org/contribute-code.html#code-style
We have more rules than these projects though. So there needs to be an
additional section of where to find settings for each IDE and how to apply
them.
Chandni
On Tue, Dec 15, 2015 at 2:30 PM, Chandni Singh <ch...@datatorrent.com>
wrote:
> These are some examples :
> https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
> https://flink.apache.org/contribute-code.html#code-style
>
> Chandni
>
> On Tue, Dec 15, 2015 at 2:22 PM, Munagala Ramanath <ra...@datatorrent.com>
> wrote:
>
>> Hi Chandni,
>>
>> Wanted to get some more info about what you're looking for here.
>> Chetan sent out email July 10 with this text:
>>
>> --------------------------------
>> Guys,
>>
>> Knowing that we all follow different coding conventions and we are now
>> going to make a big announcement about Apex, it's a good idea to define
>> code
>> formatting standards which not only we will follow but ask even the
>> outside
>> contributors to follow.
>>
>> At the high level, what the common coding standard will give us are 2
>> things:
>>
>> 1. A warm feeling that code style is consistent.
>> 2. Will not cause unnecessary change sets.
>>
>> Given that there are a bunch of different styles, please read up about
>> those and make up your mind on which style you prefer. The link on
>> Wikipedia is concise and short: http://en.wikipedia.org/wiki/Indent_style
>> to help you get started.
>>
>> I also have a short survey for you to vote. Please vote for your style. If
>> there is an absolute majority for a specific coding style, we will go with
>> it. In other cases it will help in developing consensus.
>>
>> https://www.surveymonkey.com/r/QQGCFW6
>>
>> --------------------------------
>>
>> and there were some followup messages. Do we want to pick one of the
>> existing guides like:
>>
>> http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
>> http://google.github.io/styleguide/javaguide.html
>>
>> or are we looking to write an entirely new one for Apex based on the
>> existing code base ?
>> If we write a new one, do we want to put it in the code repo or on docs
>> repo ?
>>
>> I'll post a followup to the list once I have a better idea of what you're
>> thinking.
>>
>> Ram
>>
>> On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <ch...@datatorrent.com>
>> wrote:
>>
>> > Hi,
>> >
>> > https://malhar.atlassian.net/browse/APEX-180
>> >
>> > Will anyone like to take up this JIRA?
>> >
>> > We have increasing contributions and it will be helpful if we have style
>> > guideline in place and integrated with
>> > http://apex.incubator.apache.org/contributing.html
>> >
>> > I can help out as well.
>> >
>> > Thanks,
>> > Chandni
>> >
>>
>
>
Re: Code style guidelines - any volunteers?
Posted by Chandni Singh <ch...@datatorrent.com>.
These are some examples :
https://cwiki.apache.org/confluence/display/SPARK/Spark+Code+Style+Guide
https://flink.apache.org/contribute-code.html#code-style
Chandni
On Tue, Dec 15, 2015 at 2:22 PM, Munagala Ramanath <ra...@datatorrent.com>
wrote:
> Hi Chandni,
>
> Wanted to get some more info about what you're looking for here.
> Chetan sent out email July 10 with this text:
>
> --------------------------------
> Guys,
>
> Knowing that we all follow different coding conventions and we are now
> going to make a big announcement about Apex, it's a good idea to define
> code
> formatting standards which not only we will follow but ask even the outside
> contributors to follow.
>
> At the high level, what the common coding standard will give us are 2
> things:
>
> 1. A warm feeling that code style is consistent.
> 2. Will not cause unnecessary change sets.
>
> Given that there are a bunch of different styles, please read up about
> those and make up your mind on which style you prefer. The link on
> Wikipedia is concise and short: http://en.wikipedia.org/wiki/Indent_style
> to help you get started.
>
> I also have a short survey for you to vote. Please vote for your style. If
> there is an absolute majority for a specific coding style, we will go with
> it. In other cases it will help in developing consensus.
>
> https://www.surveymonkey.com/r/QQGCFW6
>
> --------------------------------
>
> and there were some followup messages. Do we want to pick one of the
> existing guides like:
>
> http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
> http://google.github.io/styleguide/javaguide.html
>
> or are we looking to write an entirely new one for Apex based on the
> existing code base ?
> If we write a new one, do we want to put it in the code repo or on docs
> repo ?
>
> I'll post a followup to the list once I have a better idea of what you're
> thinking.
>
> Ram
>
> On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <ch...@datatorrent.com>
> wrote:
>
> > Hi,
> >
> > https://malhar.atlassian.net/browse/APEX-180
> >
> > Will anyone like to take up this JIRA?
> >
> > We have increasing contributions and it will be helpful if we have style
> > guideline in place and integrated with
> > http://apex.incubator.apache.org/contributing.html
> >
> > I can help out as well.
> >
> > Thanks,
> > Chandni
> >
>
Re: Code style guidelines - any volunteers?
Posted by Munagala Ramanath <ra...@datatorrent.com>.
Hi Chandni,
Wanted to get some more info about what you're looking for here.
Chetan sent out email July 10 with this text:
--------------------------------
Guys,
Knowing that we all follow different coding conventions and we are now
going to make a big announcement about Apex, it's a good idea to define code
formatting standards which not only we will follow but ask even the outside
contributors to follow.
At the high level, what the common coding standard will give us are 2
things:
1. A warm feeling that code style is consistent.
2. Will not cause unnecessary change sets.
Given that there are a bunch of different styles, please read up about
those and make up your mind on which style you prefer. The link on
Wikipedia is concise and short: http://en.wikipedia.org/wiki/Indent_style
to help you get started.
I also have a short survey for you to vote. Please vote for your style. If
there is an absolute majority for a specific coding style, we will go with
it. In other cases it will help in developing consensus.
https://www.surveymonkey.com/r/QQGCFW6
--------------------------------
and there were some followup messages. Do we want to pick one of the
existing guides like:
http://web.archive.org/web/20090911103851/http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
http://google.github.io/styleguide/javaguide.html
or are we looking to write an entirely new one for Apex based on the
existing code base ?
If we write a new one, do we want to put it in the code repo or on docs
repo ?
I'll post a followup to the list once I have a better idea of what you're
thinking.
Ram
On Tue, Dec 15, 2015 at 2:02 PM, Chandni Singh <ch...@datatorrent.com>
wrote:
> Hi,
>
> https://malhar.atlassian.net/browse/APEX-180
>
> Will anyone like to take up this JIRA?
>
> We have increasing contributions and it will be helpful if we have style
> guideline in place and integrated with
> http://apex.incubator.apache.org/contributing.html
>
> I can help out as well.
>
> Thanks,
> Chandni
>