Hi, I have just made my first code commits. However, I had no code rules to go by so I've tried to copy existing code. The problem is that the existing code is not consistent itself!... I would like us to define what are our coding rules. Questions such as: - max number of characters on a ligne. 100? 120? More? - indentation rules - spacing rules, like "(SomeClass)myobject" or "(SomeClass) myobject" - etc We could of course have a wiki topic for describing the rules but I don't think that's the right approach. I would prefer doing what I've done on my other projects: have a checkstyle.xml file describing those rules and apply them in the build. ATM as we have lots of inconstancies, the build would not fail on checkstyle error. However we should work towards eliminating checkstyle violations and move the checks, one by one, from warning to error (error fails the build). WDYT? Thanks -Vincent _____________________________________________________________________________ D�couvrez le nouveau Yahoo! Mail : 1 Go d'espace de stockage pour vos mails, photos et vid�os ! Cr�ez votre Yahoo! Mail sur http://fr.mail.yahoo.com
Hi Vincent, Currently the coding rules is the default coding rules from IntelliJ.. I try to use the auto-formatting function of IntelliJ to the code I commit. This might not be a very good approach in respect to other tools used for developpement and the fact that there is no control that it is done properly. Concerning your proposal of checkstyle.xml, when you say "applying them in the build", would the build then commit the source files if there are changes or at least report any non compliance ? Ludovic Vincent Massol a écrit :
Hi,
I have just made my first code commits. However, I had no code rules to go by so I've tried to copy existing code. The problem is that the existing code is not consistent itself!...
I would like us to define what are our coding rules. Questions such as: - max number of characters on a ligne. 100? 120? More? - indentation rules - spacing rules, like "(SomeClass)myobject" or "(SomeClass) myobject" - etc
We could of course have a wiki topic for describing the rules but I don't think that's the right approach. I would prefer doing what I've done on my other projects: have a checkstyle.xml file describing those rules and apply them in the build.
ATM as we have lots of inconstancies, the build would not fail on checkstyle error. However we should work towards eliminating checkstyle violations and move the checks, one by one, from warning to error (error fails the build).
WDYT?
Thanks -Vincent
_____________________________________________________________________________ Découvrez le nouveau Yahoo! Mail : 1 Go d'espace de stockage pour vos mails, photos et vidéos ! Créez votre Yahoo! Mail sur http://fr.mail.yahoo.com
------------------------------------------------------------------------
-- You receive this message as a subscriber of the [email protected] mailing list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Ludovic Dubost XPertNet: http://www.xpertnet.fr/ Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost AIM: nvludo Yahoo: ludovic
-----Original Message----- From: Ludovic Dubost [mailto:[email protected]] Sent: jeudi 2 juin 2005 10:41 To: [email protected] Subject: Re: [xwiki-dev] [Checkstyle] Coding rules
Hi Vincent,
Currently the coding rules is the default coding rules from IntelliJ.. I try to use the auto-formatting function of IntelliJ to the code I commit.
Ok, we'll need to find out what those default coding rules are.
This might not be a very good approach in respect to other tools used for developpement and the fact that there is no control that it is done properly.
Concerning your proposal of checkstyle.xml, when you say "applying them in the build", would the build then commit the source files if there are changes or at least report any non compliance ?
I'm not suggesting that the build will auto-format the source (this should be done in your IDE as you're currently doing in IDEA). The build will report the non-compliance and fail the build when we are ready for that. It'll only give warnings initially. -Vincent
Ludovic
Vincent Massol a écrit :
Hi,
I have just made my first code commits. However, I had no code rules to go by so I've tried to copy existing code. The problem is that the existing code is not consistent itself!...
I would like us to define what are our coding rules. Questions such as: - max number of characters on a ligne. 100? 120? More? - indentation rules - spacing rules, like "(SomeClass)myobject" or "(SomeClass) myobject" - etc
We could of course have a wiki topic for describing the rules but I don't think that's the right approach. I would prefer doing what I've done on my other projects: have a checkstyle.xml file describing those rules and apply them in the build.
ATM as we have lots of inconstancies, the build would not fail on checkstyle error. However we should work towards eliminating checkstyle violations and move the checks, one by one, from warning to error (error fails the build).
WDYT?
Thanks -Vincent
_________________________________________________________________________
Découvrez le nouveau Yahoo! Mail : 1 Go d'espace de stockage pour vos mails, photos et vidéos ! Créez votre Yahoo! Mail sur http://fr.mail.yahoo.com
------------------------------------------------------------------------
-- You receive this message as a subscriber of the [email protected] mailing list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Ludovic Dubost XPertNet: http://www.xpertnet.fr/ Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost AIM: nvludo Yahoo: ludovic
_____________________________________________________________________________ Découvrez le nouveau Yahoo! Mail : 1 Go d'espace de stockage pour vos mails, photos et vidéos ! Créez votre Yahoo! Mail sur http://fr.mail.yahoo.com
participants (4)
-
Alexis KARTMANN -
Jim Stuttard -
Ludovic Dubost -
Vincent Massol