Working with the Code

Working with the Code

Before you submit a patch or commit changes, please take the time to do a full mvn clean install site then inspect the following:

• target/site/index.html -- it's where the maven site for the project is built, that has links to all the project reports like FindBugs, Checkstyle, PMD and CPD reports, however, please find below the links directly to these. Make sure there are no reported issues with any of these before you commit!
• target/site/findbugs.html -- results of FindBugs analysis. Please do not introduce bugs :)
• target/site/checkstyle.html -- this tool ensures we all use the same formatting/writing code style, which is based on Apache's conventions.
• target/site/pmd.html -- the PMD tool assists with finding more complex bugs, make sure there's nothing reported here too
• target/site/cpd.html -- this is the "copy paste detector" report, if this signals pieces of code that are identical in multiple parts of the code, this calls for a refactoring (separate that piece of code in a method on it's own and invoke it).