Details
-
Improvement
-
Status: Open
-
Minor
-
Resolution: Unresolved
-
None
-
None
-
None
-
None
Description
This is an ongoing meta-issue for improving the Checkstyle conformance of the Jackrabbit codebase.
Checkstyle (http://checkstyle.sourceforge.net/) is an automated tool for checking conformance with coding standard and good coding style. A Checkstyle report for Jackrabbit can be generated by running "maven checkstyle".
Currently the Jackrabbit Checkstyle report contains thousands of trivial problems like unused imports and minor formatting issues. While it would be possible to just remove those checks from the Jackrabbit Checkstyle configuration, it would certainly be better to fix the real issues. After fixing the trivial problems, the Checkstyle reports become much more valuable tools in locating troublesome code and identifying chances for improvement.
While this issue remains open, you have an open mandate to improve the standards conformance and coding style of the Jackrabbit sources. This mandate applies only to changes that fix problems reported by Checkstyle while making no changes to the external interface or behaviour of the changed code.
The commit messages of such Checkstyle improvements should be labeled with the Jira key of this issue (JCR-97) to mark the changes as style-only. This way other committers will have easier time reviewing your changes for bugs or other unexpected side-effects.
If you are not a Jackrabbit committer, but want to help improve the Checkstyle conformance, you can make your changes using sources from anonymous subversion and send your changes as an attachment to this issue. Please see the Javadoc improvement issue JCR-73 for details.
PS. Blind conformance to style guides is seldom beneficial. Please remember that the goal of this issue is to improve Jackrabbit code, not just the Checkstyle output!