Hi Chico, The plan could be: - firstly create an issue in Jira to track this - prioritize the quality items: checkstyle, cobertura, cpd/pmd, findbugs
Checkstyle is probably the most easiest to do (with your favourite IDE!) CPD will be also easy to fix. Cobertura is arguable, specially in common used by others projects, but I am confident that we could improve the test coverage with more test cases. Findbugs contains a lot of potential issues and some of them are easy to fix or wont fix. We probably need to prioritize them and see if we want to fix them or not. Cheers, Vincent 2009/4/23, chico charlesworth <[email protected]>: > Hi, > > First I would like to say that imho the shindig code base is in good shape > and in good hands, yet I think code quality is always an area which can be > improved. For example, the introduction of code reviews has greatly > benefited this, and I think has been welcomed by everyone. > > One thing that I reckon would help further is to regularly check and address > the maven reports (e.g. code coverage, findbugs, pmd, taglist, etc). At the > moment if we look at shindig-1.1.x this is what is reported: > - common > - 57% overall coverage ( > > http://incubator.apache.org/shindig/shindig-1.1.x/shindig-parent/shindig-common/cobertura/index.html > ) > - 40 findbugs issues ( > > http://incubator.apache.org/shindig/shindig-1.1.x/shindig-parent/shindig-common/findbugs.html > ) > - social-api > - 76% overall coverage ( > > http://incubator.apache.org/shindig/shindig-1.1.x/shindig-parent/shindig-social-api/cobertura/index.html), > but org.apache.shindig.social.sample package has 0% coverage. > - 40 findbugs issues ( > > http://incubator.apache.org/shindig/shindig-1.1.x/shindig-parent/shindig-social-api/findbugs.html > ) > - gadgets > - 83% overall coverage ( > > http://incubator.apache.org/shindig/shindig-1.1.x/shindig-parent/shindig-gadgets/cobertura/index.html > ) > - 100 findbugs issues ( > > http://incubator.apache.org/shindig/shindig-1.1.x/shindig-parent/shindig-gadgets/cobertura/index.html > ) > > Considering the observations above, does anyone have suggestions on how we > can further improve the quality of the code base? As a start we could start > looking at improving the test coverage for the common module and to start > reducing the number of findbugs issues. I believe as a group effort this > could be achieved. > > Cheers > > Chico >
