## Friday, July 31, 2009

### Things to check before you consider submitting a (final) CDK patch #1

Mark the final in the above title; if you merely seek advice on your patch, feel free to send them in whatever state. However, if you bring up your patch for peer review, make sure to have gone through the following steps, in random order:
• be prepared for peer review feedback
• realize your code will have to be LGPL or LGPL-compatible
• make sure the copyright lines are properly updated (see Making patches; Attribution; Copyright and License.)
• your code is fully unit tested
• your code does not cause PMD failures
• no empty templates
• JavaDoc for every class field, method and class
• use of {@link}
• use of CDK tags @cdk.bug, @cdk.cite, etc
• period at the end of the first sentence
• ...
• make sure all the code still compiles
$cd cdk/$ ant clean dist-all test-dist-all$ant -Dmodule=uff test-module$ ant -f javadoc.xml -Dmodule=uff doccheck-module$ant -f pmd.xml -Dpmd.test=custom -Dmodule=uff test-module$ ant -f pmd.xml -Dpmd.test=custom -Dmodule=test-uff test-module