Code Review Checklist

Code Review Checklist

Coding Style

• new code:
  • please adds an Apache License header for each new file
  • follows Sun's code conventions except indentation is 2 spaces, not 4
  • English comment
  • UTF-8 code encoding
  • UNIX line dilimiter
• changes to existing code:
  • maintains existing style
  • English comment
  • UTF-8 code encoding
  • UNIX line dilimiter

Documentation

• internal javadoc:
• accurate, sufficient for future maintainability
• public javadoc:
• accurate, sufficient for developers to code against
• follows standard javadoc conventions
• loggers and logging levels covered if they do not follow our conventions (see below)
• system properties, configuration options, and resources covered
• illegal arguments are properly documented as appropriate
• package and overview javadoc are updated as appropriate