Code Reviews

Has it matched the specification?

Has it passed CI?

  • Travis - Are your tests passing?
  • Hound - Are there any style guide violations?
  • Coveralls - How much test coverage do you have?

What we look for

  • OOD
  • OOP
  • TDD
  • MVC
  • DRY
  • KISS
  • YAGNI
  • POLA

Object-Oriented Design (OOD)

  • Is it well-designed?
  • Does each object do one thing and one thing well?

Object-Oriented Programming (OOP)

  • Are your objects SOLID (particularly the Single Responsibility Principle)?
  • Is it well encapsulated?

Test-Driven Development (TDD)

  • How well tested is it?
  • Do the tests read well as documentation?
  • How comprehensively tested is it?
  • Are there magic numbers?

Don't Repeat Yourself (DRY)

  • Are you repeating yourself?
  • Can you better abstract your code?

Model View Controller (MVC)

  • Have you kept your controllers skinny?
  • Is there too much logic in your views?
  • Are your models unit-tested where needed?
  • Have you encapsulated logic into your models?

Is your code well-written?

  • Keep It Simple Stupid (KISS)
  • You Ain't Gonna Need It (YAGNI)
  • Principle of Least Astonishment (POLA)

Code Reviews

By Leo Allen

Code Reviews

How to do code reviews

  • 1,234