You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by Rene Gielen <rg...@apache.org> on 2011/04/23 13:23:20 UTC
Commiters info: coding conventions
By incident I realized that some commits lately introduced tab
characters for indentation. Generally there is nothing wrong with this,
except that there is a historic agreement that we want to favor space
character over tabs for the Struts codebase - which is a hard to find
information for new committers, I have to admit.
As for code style in general we follow the official Java Code
Conventions [1], which leaves open whether to use tab or space
characters. The main reasons why both the original Struts project as
well as the WebWork project - which was merged into the Struts project
as the base for Struts 2 - agreed on a "no tab character" convention are
- commit messages are generally more readable with spaces
- while the Java Coding Conventions [1] allow for both types of
indentation, they request an indent unit of 4 spaces as well as a tab
width of 8 spaces. To follow both rules, one would have to mix tabs and
spaces for each odd number of indents if the tab character were to be used.
The good thing is that nowadays with IDEs like Eclipse, Netbeans or IDEA
it's just a tick in a preference box to change that style for your
commits. As for IDEA eg. you can create profiles if your daily coding
convention differs from the project's.
As a side note, Jetbrains and other commercial tool providers kindly
support open source with free licenses. With your Apache email address
it is very simple to apply for those licenses - so if you ever wanted to
try one of those products, this is a good chance.
[1] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
- René
--
René Gielen
http://twitter.com/rgielen
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Commiters info: coding conventions
Posted by Christian Grobmeier <gr...@gmail.com>.
> Never too late :)
>
> A new page in the Wiki would be IMHO a nice idea, along the lines of your patches-page suggestion. It would be easily maintainable then, and we could link to it from the other suggested pages / sections.
>
> And since sources say your CLA is on file even you could go ahead and start the page :)
No problem, will gladly take care on this
Cheers
Christian
>
> - René
>
> Sent from my iPad
>
> On 25.08.2011, at 14:47, Christian Grobmeier <gr...@gmail.com> wrote:
>
>> yes, I am bit late on this e-mail.
>> Every project has different opinions on Code Conventions and
>> tabs/spaces. I would like to recommend to push this information to the
>> struts website somewhere. I could not easily find it online, but I
>> think it would help new developers to find their way.
>>
>> Maybe there?
>> http://struts.apache.org/helping.html#contribute
>> Or there?
>> http://struts.apache.org/dev/builds.html
>>
>> or even a new page like:
>> http://commons.apache.org/patches.html
>>
>> best regards,
>> Christian
>>
>>
>> On Sat, Apr 23, 2011 at 1:23 PM, Rene Gielen <rg...@apache.org> wrote:
>>> By incident I realized that some commits lately introduced tab
>>> characters for indentation. Generally there is nothing wrong with this,
>>> except that there is a historic agreement that we want to favor space
>>> character over tabs for the Struts codebase - which is a hard to find
>>> information for new committers, I have to admit.
>>>
>>> As for code style in general we follow the official Java Code
>>> Conventions [1], which leaves open whether to use tab or space
>>> characters. The main reasons why both the original Struts project as
>>> well as the WebWork project - which was merged into the Struts project
>>> as the base for Struts 2 - agreed on a "no tab character" convention are
>>>
>>> - commit messages are generally more readable with spaces
>>> - while the Java Coding Conventions [1] allow for both types of
>>> indentation, they request an indent unit of 4 spaces as well as a tab
>>> width of 8 spaces. To follow both rules, one would have to mix tabs and
>>> spaces for each odd number of indents if the tab character were to be used.
>>>
>>> The good thing is that nowadays with IDEs like Eclipse, Netbeans or IDEA
>>> it's just a tick in a preference box to change that style for your
>>> commits. As for IDEA eg. you can create profiles if your daily coding
>>> convention differs from the project's.
>>>
>>> As a side note, Jetbrains and other commercial tool providers kindly
>>> support open source with free licenses. With your Apache email address
>>> it is very simple to apply for those licenses - so if you ever wanted to
>>> try one of those products, this is a good chance.
>>>
>>> [1] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
>>>
>>> - René
>>>
>>> --
>>> René Gielen
>>> http://twitter.com/rgielen
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>>> For additional commands, e-mail: dev-help@struts.apache.org
>>>
>>>
>>
>>
>>
>> --
>> http://www.grobmeier.de
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> For additional commands, e-mail: dev-help@struts.apache.org
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>
--
http://www.grobmeier.de
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Commiters info: coding conventions
Posted by Rene Gielen <gi...@it-neering.net>.
Christian,
thanks for your help!
The Struts site is maintained as it's own maven site project in SVN,
thus it is only editable with commit rights. I've added a section
linking to your article in the FAQ#patches section. Should be online soon.
- René
Am 27.08.11 04:52, schrieb Christian Grobmeier:
> René,
>
> just added the page:
> https://cwiki.apache.org/confluence/display/S2WIKI/Struts+2+Coding+Conventions
> based on what you wrote. Please excuse spelling errors.
>
> I just tried to find the struts pages to link to it in the repository.
> But it seems the Struts 2 site is stored in Confluence too, is that
> correct?
> I looked into struts-core/src/site
>
> If it is in confluence, then I assume I cannot help. And I think
> Confluence Autoexport is not longer supported by our Infra. Maybe
> there is need of discussion to move for example to the ASF CMS. Infra
> can help with that move I think
>
> Cheers
>
>
> On Fri, Aug 26, 2011 at 10:44 AM, Rene Gielen
> <re...@googlemail.com> wrote:
>> Never too late :)
>>
>> A new page in the Wiki would be IMHO a nice idea, along the lines of your patches-page suggestion. It would be easily maintainable then, and we could link to it from the other suggested pages / sections.
>>
>> And since sources say your CLA is on file even you could go ahead and start the page :)
>>
>> - René
>>
>> Sent from my iPad
>>
>> On 25.08.2011, at 14:47, Christian Grobmeier <gr...@gmail.com> wrote:
>>
>>> yes, I am bit late on this e-mail.
>>> Every project has different opinions on Code Conventions and
>>> tabs/spaces. I would like to recommend to push this information to the
>>> struts website somewhere. I could not easily find it online, but I
>>> think it would help new developers to find their way.
>>>
>>> Maybe there?
>>> http://struts.apache.org/helping.html#contribute
>>> Or there?
>>> http://struts.apache.org/dev/builds.html
>>>
>>> or even a new page like:
>>> http://commons.apache.org/patches.html
>>>
>>> best regards,
>>> Christian
>>>
>>>
>>> On Sat, Apr 23, 2011 at 1:23 PM, Rene Gielen <rg...@apache.org> wrote:
>>>> By incident I realized that some commits lately introduced tab
>>>> characters for indentation. Generally there is nothing wrong with this,
>>>> except that there is a historic agreement that we want to favor space
>>>> character over tabs for the Struts codebase - which is a hard to find
>>>> information for new committers, I have to admit.
>>>>
>>>> As for code style in general we follow the official Java Code
>>>> Conventions [1], which leaves open whether to use tab or space
>>>> characters. The main reasons why both the original Struts project as
>>>> well as the WebWork project - which was merged into the Struts project
>>>> as the base for Struts 2 - agreed on a "no tab character" convention are
>>>>
>>>> - commit messages are generally more readable with spaces
>>>> - while the Java Coding Conventions [1] allow for both types of
>>>> indentation, they request an indent unit of 4 spaces as well as a tab
>>>> width of 8 spaces. To follow both rules, one would have to mix tabs and
>>>> spaces for each odd number of indents if the tab character were to be used.
>>>>
>>>> The good thing is that nowadays with IDEs like Eclipse, Netbeans or IDEA
>>>> it's just a tick in a preference box to change that style for your
>>>> commits. As for IDEA eg. you can create profiles if your daily coding
>>>> convention differs from the project's.
>>>>
>>>> As a side note, Jetbrains and other commercial tool providers kindly
>>>> support open source with free licenses. With your Apache email address
>>>> it is very simple to apply for those licenses - so if you ever wanted to
>>>> try one of those products, this is a good chance.
>>>>
>>>> [1] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
>>>>
>>>> - René
>>>>
>>>> --
>>>> René Gielen
>>>> http://twitter.com/rgielen
>>>>
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>>>> For additional commands, e-mail: dev-help@struts.apache.org
>>>>
>>>>
>>>
>>>
>>>
>>> --
>>> http://www.grobmeier.de
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>>> For additional commands, e-mail: dev-help@struts.apache.org
>>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> For additional commands, e-mail: dev-help@struts.apache.org
>>
>>
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Commiters info: coding conventions
Posted by Christian Grobmeier <gr...@gmail.com>.
René,
just added the page:
https://cwiki.apache.org/confluence/display/S2WIKI/Struts+2+Coding+Conventions
based on what you wrote. Please excuse spelling errors.
I just tried to find the struts pages to link to it in the repository.
But it seems the Struts 2 site is stored in Confluence too, is that
correct?
I looked into struts-core/src/site
If it is in confluence, then I assume I cannot help. And I think
Confluence Autoexport is not longer supported by our Infra. Maybe
there is need of discussion to move for example to the ASF CMS. Infra
can help with that move I think
Cheers
On Fri, Aug 26, 2011 at 10:44 AM, Rene Gielen
<re...@googlemail.com> wrote:
> Never too late :)
>
> A new page in the Wiki would be IMHO a nice idea, along the lines of your patches-page suggestion. It would be easily maintainable then, and we could link to it from the other suggested pages / sections.
>
> And since sources say your CLA is on file even you could go ahead and start the page :)
>
> - René
>
> Sent from my iPad
>
> On 25.08.2011, at 14:47, Christian Grobmeier <gr...@gmail.com> wrote:
>
>> yes, I am bit late on this e-mail.
>> Every project has different opinions on Code Conventions and
>> tabs/spaces. I would like to recommend to push this information to the
>> struts website somewhere. I could not easily find it online, but I
>> think it would help new developers to find their way.
>>
>> Maybe there?
>> http://struts.apache.org/helping.html#contribute
>> Or there?
>> http://struts.apache.org/dev/builds.html
>>
>> or even a new page like:
>> http://commons.apache.org/patches.html
>>
>> best regards,
>> Christian
>>
>>
>> On Sat, Apr 23, 2011 at 1:23 PM, Rene Gielen <rg...@apache.org> wrote:
>>> By incident I realized that some commits lately introduced tab
>>> characters for indentation. Generally there is nothing wrong with this,
>>> except that there is a historic agreement that we want to favor space
>>> character over tabs for the Struts codebase - which is a hard to find
>>> information for new committers, I have to admit.
>>>
>>> As for code style in general we follow the official Java Code
>>> Conventions [1], which leaves open whether to use tab or space
>>> characters. The main reasons why both the original Struts project as
>>> well as the WebWork project - which was merged into the Struts project
>>> as the base for Struts 2 - agreed on a "no tab character" convention are
>>>
>>> - commit messages are generally more readable with spaces
>>> - while the Java Coding Conventions [1] allow for both types of
>>> indentation, they request an indent unit of 4 spaces as well as a tab
>>> width of 8 spaces. To follow both rules, one would have to mix tabs and
>>> spaces for each odd number of indents if the tab character were to be used.
>>>
>>> The good thing is that nowadays with IDEs like Eclipse, Netbeans or IDEA
>>> it's just a tick in a preference box to change that style for your
>>> commits. As for IDEA eg. you can create profiles if your daily coding
>>> convention differs from the project's.
>>>
>>> As a side note, Jetbrains and other commercial tool providers kindly
>>> support open source with free licenses. With your Apache email address
>>> it is very simple to apply for those licenses - so if you ever wanted to
>>> try one of those products, this is a good chance.
>>>
>>> [1] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
>>>
>>> - René
>>>
>>> --
>>> René Gielen
>>> http://twitter.com/rgielen
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>>> For additional commands, e-mail: dev-help@struts.apache.org
>>>
>>>
>>
>>
>>
>> --
>> http://www.grobmeier.de
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> For additional commands, e-mail: dev-help@struts.apache.org
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>
--
http://www.grobmeier.de
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Commiters info: coding conventions
Posted by Rene Gielen <re...@googlemail.com>.
Never too late :)
A new page in the Wiki would be IMHO a nice idea, along the lines of your patches-page suggestion. It would be easily maintainable then, and we could link to it from the other suggested pages / sections.
And since sources say your CLA is on file even you could go ahead and start the page :)
- René
Sent from my iPad
On 25.08.2011, at 14:47, Christian Grobmeier <gr...@gmail.com> wrote:
> yes, I am bit late on this e-mail.
> Every project has different opinions on Code Conventions and
> tabs/spaces. I would like to recommend to push this information to the
> struts website somewhere. I could not easily find it online, but I
> think it would help new developers to find their way.
>
> Maybe there?
> http://struts.apache.org/helping.html#contribute
> Or there?
> http://struts.apache.org/dev/builds.html
>
> or even a new page like:
> http://commons.apache.org/patches.html
>
> best regards,
> Christian
>
>
> On Sat, Apr 23, 2011 at 1:23 PM, Rene Gielen <rg...@apache.org> wrote:
>> By incident I realized that some commits lately introduced tab
>> characters for indentation. Generally there is nothing wrong with this,
>> except that there is a historic agreement that we want to favor space
>> character over tabs for the Struts codebase - which is a hard to find
>> information for new committers, I have to admit.
>>
>> As for code style in general we follow the official Java Code
>> Conventions [1], which leaves open whether to use tab or space
>> characters. The main reasons why both the original Struts project as
>> well as the WebWork project - which was merged into the Struts project
>> as the base for Struts 2 - agreed on a "no tab character" convention are
>>
>> - commit messages are generally more readable with spaces
>> - while the Java Coding Conventions [1] allow for both types of
>> indentation, they request an indent unit of 4 spaces as well as a tab
>> width of 8 spaces. To follow both rules, one would have to mix tabs and
>> spaces for each odd number of indents if the tab character were to be used.
>>
>> The good thing is that nowadays with IDEs like Eclipse, Netbeans or IDEA
>> it's just a tick in a preference box to change that style for your
>> commits. As for IDEA eg. you can create profiles if your daily coding
>> convention differs from the project's.
>>
>> As a side note, Jetbrains and other commercial tool providers kindly
>> support open source with free licenses. With your Apache email address
>> it is very simple to apply for those licenses - so if you ever wanted to
>> try one of those products, this is a good chance.
>>
>> [1] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
>>
>> - René
>>
>> --
>> René Gielen
>> http://twitter.com/rgielen
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> For additional commands, e-mail: dev-help@struts.apache.org
>>
>>
>
>
>
> --
> http://www.grobmeier.de
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org
Re: Commiters info: coding conventions
Posted by Christian Grobmeier <gr...@gmail.com>.
yes, I am bit late on this e-mail.
Every project has different opinions on Code Conventions and
tabs/spaces. I would like to recommend to push this information to the
struts website somewhere. I could not easily find it online, but I
think it would help new developers to find their way.
Maybe there?
http://struts.apache.org/helping.html#contribute
Or there?
http://struts.apache.org/dev/builds.html
or even a new page like:
http://commons.apache.org/patches.html
best regards,
Christian
On Sat, Apr 23, 2011 at 1:23 PM, Rene Gielen <rg...@apache.org> wrote:
> By incident I realized that some commits lately introduced tab
> characters for indentation. Generally there is nothing wrong with this,
> except that there is a historic agreement that we want to favor space
> character over tabs for the Struts codebase - which is a hard to find
> information for new committers, I have to admit.
>
> As for code style in general we follow the official Java Code
> Conventions [1], which leaves open whether to use tab or space
> characters. The main reasons why both the original Struts project as
> well as the WebWork project - which was merged into the Struts project
> as the base for Struts 2 - agreed on a "no tab character" convention are
>
> - commit messages are generally more readable with spaces
> - while the Java Coding Conventions [1] allow for both types of
> indentation, they request an indent unit of 4 spaces as well as a tab
> width of 8 spaces. To follow both rules, one would have to mix tabs and
> spaces for each odd number of indents if the tab character were to be used.
>
> The good thing is that nowadays with IDEs like Eclipse, Netbeans or IDEA
> it's just a tick in a preference box to change that style for your
> commits. As for IDEA eg. you can create profiles if your daily coding
> convention differs from the project's.
>
> As a side note, Jetbrains and other commercial tool providers kindly
> support open source with free licenses. With your Apache email address
> it is very simple to apply for those licenses - so if you ever wanted to
> try one of those products, this is a good chance.
>
> [1] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
>
> - René
>
> --
> René Gielen
> http://twitter.com/rgielen
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>
--
http://www.grobmeier.de
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org