Add Coding Guidelines to GWT-OpenLayers

[TDesjardins]

The code style of GWT-OpenLayers isn't homogenous. For example: mixed usage of tabs and blanks for indentations and different positons of braces.
I think this aggravates the maintenance of the code and often it makes it difficult to see real code changes in commits etc.
I think a solution is to provide a checkstyle.xml or something similar, so the contributors can check the code with the IDE before creating a pull request. So the codebase will become more homogenous step-by-step.

[glascaleia]

I agree with you. Some people use different IDE.
So +1 here for this proposal.
May you create a configuration file to do this??
Regards Giuseppe

2014-09-10 10:39 GMT+02:00 TDesjardins [email protected]:

The code style of GWT-OpenLayers isn't homogenous. For example: mixed
usage of tabs and blanks for indentations and different positons of braces.
I think this aggravates the maintenance of the code and often it makes it
difficult to see real code changes in commits etc.
I think a solution is to provide a checkstyle.xml or something similar, so
the contributors can check the code with the IDE before creating a pull
request. So the codebase will become more homogenous step-by-step.

—
Reply to this email directly or view it on GitHub
#23.

Giuseppe La Scaleia
CNR - IMAA
geoSDI
Sviluppo Software

C.da S. Loja
85050 Tito Scalo - POTENZA (PZ)
Italia

phone: +39 0971427305
fax: +39 0971 427271
mob: +39 3312174998
mail: [email protected]
skype: glascaleia

web: http://www.geosdi.org

[fizzi]

+1 also for me.

2014-09-10 10:42 GMT+02:00 Giuseppe La Scaleia [email protected]:

I agree with you. Some people use different IDE.
So +1 here for this proposal.
May you create a configuration file to do this??
Regards Giuseppe

2014-09-10 10:39 GMT+02:00 TDesjardins [email protected]:

The code style of GWT-OpenLayers isn't homogenous. For example: mixed
usage of tabs and blanks for indentations and different positons of
braces.
I think this aggravates the maintenance of the code and often it makes
it
difficult to see real code changes in commits etc.
I think a solution is to provide a checkstyle.xml or something similar,
so
the contributors can check the code with the IDE before creating a pull
request. So the codebase will become more homogenous step-by-step.

—
Reply to this email directly or view it on GitHub
#23.

Giuseppe La Scaleia
CNR - IMAA
geoSDI
Sviluppo Software

C.da S. Loja
85050 Tito Scalo - POTENZA (PZ)
Italia

phone: +39 0971427305
fax: +39 0971 427271
mob: +39 3312174998
mail: [email protected]
skype: glascaleia

web: http://www.geosdi.org

—
Reply to this email directly or view it on GitHub
#23 (comment)
.

Francesco Izzi
CNR - IMAA
geoSDI
Direzione Tecnologie e Sviluppo

C.da S. Loja
85050 Tito Scalo - POTENZA (PZ)
Italia

phone: +39 0971427310
fax: +39 0971 427271
mob: +39 3666373172
mail: [email protected]
skype: neofx8080

web: http://www.geosdi.org

[TDesjardins]

O.k. nice to hear. I can create a base configuration file with checkstyle. I think this should be orientated to the Java- and perhaps the GWT-Styleguides ( https://github.com/stephenh/google-web-toolkit/blob/master/eclipse/settings/code-style/gwt-checkstyle.xml ) ? Another possibility is to take the Java-Styleguide and add specifications that preferably fits the GWT-OpenLayers codebase. So we can avoid to much code changes for formatting.

Regards

Tino