Code Review Checklist

Goals

• Confirm Coder has completed the Challenge
• Improve style, architecture, & maintainability of code (for Project & Coder's benefits)
• Explain why any suggestions are made so Coder can improve on his/her own next time

Review Checklist

Errors

• Any clear logic problems in the code proposed?
• Are mathematical edge cases handled?
• Are calculations bounded? Any potential divide by 0, off-by-one errors, infinite loops?

Security

• Any gaping holes? Unanticipated vulnerabilities? Secret info that shouldn’t be shown?

Clarity

• Is it easy to figure out what’s happening here? Would more documentation or clearer variable names make this more understandable?

Integrity

• Does this code stand alone, or must one read the original challenge to know what it does?

Performance

• How will this solution scale? Will it suit the anticipated growth of the application?
• Threadsafety, Potential Resource Contention, Order of Execution Controls

DRY

• Are elements of this code properly abstracted, rather than repeated?

OOP Design Principles

• Encapsulation
• Data Abstraction
• Polymorphism
• Inheritence