search

spgroup / groundhog

A framework for crawling GitHub projects and raw data and to extract metrics from them
http://spgroup.github.io/groundhog
GNU General Public License v2.0
15 stars 10 forks source link

Improve code quality #6

Open rodrigoalvesvieira opened 11 years ago

rodrigoalvesvieira commented 11 years ago

This is not a to-do that might be done ASAP, but a continuous task and - in general - we should aim at making the code easier to maintain (even if we assume that there is not thousands of people interested)

The Oracle's Code Conventions for the Java TM Programming Language is a nice guide that might help us with this continuous task.

rodrigoalvesvieira commented 11 years ago

There is something else related to this issue that we can work to improve too: replace System.out.print/println calls with logger.info calls, which are actually appropriate for logging.

gustavopinto commented 11 years ago

Other point: the extractor package has the Uncompressor interface, but no one class in this package are implementing it. Or remove the interface, which, I think, is not a good idea, or force all classes to implement it.

rodrigoalvesvieira commented 11 years ago

Interesting, hadn't noticed this before. I agree with forcing the implementation.