Skip to content

Instantly share code, notes, and snippets.

@mcustiel
Last active July 13, 2021 14:56
Show Gist options
  • Save mcustiel/ace3a991d18c1cfbf7e96023c8a4a488 to your computer and use it in GitHub Desktop.
Save mcustiel/ace3a991d18c1cfbf7e96023c8a4a488 to your computer and use it in GitHub Desktop.
Code reviews checklist

1 - Tests are written for the changes

2 - Covers annotation

3 - Naming

  1. Classes
  2. Methods
  3. Properties
  4. Variables
  5. Constants
  6. Namespaces

4 - Constants are available instead of magic values

5 - Read the ticket to see what is required, verify the changes are doing that

6 - Logic issues

7 - Unoptimized code

8 - Clean code and smells

  1. Repeated code / things that can be split into a different method
  2. Things that can be split into a new class
  3. Mixing layers (domain/presentation, domain/persistence, etc)
  4. SOLID principles are being used

Etiquette as a reviewer

  1. Ask, don't tell
  2. Use links to enforce arguments when available
  3. Remember that we are all proud about our code, don't hurt feelings
  4. Code reviews are also about praising thinks well done
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment