Hi Lennart

The page over on the Maven site needs expanding a bit, I'll look into
fixing that, but in general Mojo project uses the same rules as the
Maven project when it comes to code style.

If you want to check that the style is followed you can use Checkstyle.
We have configured Checkstyle in the mojo-parent to use the
config/maven_checks.xml

If you have 0 errors in the Checkstyle report, then the code is as good
as it will ever get. If the existing code gives Checkstyle errors you
can fix them, if you have the cycles for it. Just do it as a completely
separate check-in/patch. I tend to do a quick Checkstyle raid on the
code just before a release, when all the issues planned for the release
have been fix.

On 2011-12-09 05:18, Lennart Jörelid wrote:
> Hello all,
> 
> I need a pointer in the right direction here. 
> 
> I believe the simplest way to enable people to provide patches in the
> correct format is to provide a clear, simple way to integrate code
> checks and formatting assistance into their IDEs. 
> 
> http://mojo.codehaus.org/development/guidelines.html is rather loosely
> held; while it points to the maven codestyle on
> (http://maven.apache.org/developers/committer-environment.html#Maven_Code_Style)
> this codestyle is not what is used by the project I am currently working
> on. There is simply some formatting conventions I observe in use which
> are not defined within the Maven_Code_Style - at least for the IDEA
> development environment.
> 
> Therefore - 
> 
> a) Where is our source formatting specification (checkstyle,
> Eclipse/IDEA/xxx code formatting specification)? 
> b) Does passing the checkstyle imply all code is properly formatted
> (i.e. is the error/warning/info levels set correctly on all checks?)
> c) Do we have a step-by-step introduction to how the IDE should be set
> up for people to contribute patches? (Otherwise we need to provide one)
> 
> // Bästa hälsningar,
> // [sw. "Best regards"
> //
> // Lennart Jörelid
> 


-- 
Dennis Lundberg

---------------------------------------------------------------------
To unsubscribe from this list, please visit:

    http://xircles.codehaus.org/manage_email


Reply via email to