Intermezzo Code review checklist

Review Checklist

Design

• As much logic as possible in the model and not in the controllers
• Helper objects if needed
• No logic in the views that could be handled by the controller
• Classes and especially helper classes with clear responsibilities
• Invariants with resonable assertions
• No unused or duplicated classes (views)

Coding style

• No duplicated code
• Consistent coding style
• Short and clear methods (one task per method)
• Precisely named methods and classes
• All the possible boundary values are handled somehow (user inputs, ...)
• If possible ruby idoms are used
• The objects are well encapsulated
• The invariants get checked before and after every change on the object

Documentation

• Describes responsibilities, pre- and postconditions of each method and class
• Clear and understandable
• Clear vocabulary (dont call an object differently)

Test

• Clear test cases
• Coverage is high enough
• Redable tests
• Checks every line of code or all boundary values