Skip to content

Instantly share code, notes, and snippets.

@chrisman

chrisman/code-review.md

Last active February 8, 2020 01:35
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save chrisman/2206bf81c3d47a298085dde1fb036aeb to your computer and use it in GitHub Desktop.
Save chrisman/2206bf81c3d47a298085dde1fb036aeb to your computer and use it in GitHub Desktop.
Download ZIP
Code Reviews
Raw
code-review.md

Code Reviews

It's about making code better.

Why do code reviews

  • Get better at:
    • (presenters) talking about and explaining your own code
    • (reviewers) reading and understanding somebody else's code
  • Build trust
  • Share knowledge across teams

What to review

  • 200 - 400 lines of code
  • Timeboxed to 60 minutes

What to review for

Correctness, Clarity, Effeciency, and Style

  1. Correctness: Does it do what it's supposed to do?
    • Off-by-one
    • Copy & paste / Spelling
    • Edge cases & exception handling
    • Respect for patterns
    • Data validation & security
  2. Clarity: Can someone other than the author describe what's going on?
    • Naming conventions
    • Function length & purpose
    • Library usage
    • Respect for patterns
  3. Efficiency: What's the performance impact?
    • Database queries
    • DOM manipulation
    • Asynchronous JavaScript / Digest Cycles
    • Using an ORM
  4. Style: Does this meet your style standards?
    • Comments
    • Line length
    • Naming conventions
    • Indentation

How to do reviews

Avoid generalities. Don't say:

  • This is messy
  • Nice!

Be specific. Do say:

  • This function is missing a return type.
  • Changing this nested if...else block to a lookup table will reduce the cyclomatic complexity quite a bit.

Who and When?

Denver Engineers will meet in person once a week to do code reviews

Resources

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment