Skip to content

Instantly share code, notes, and snippets.

View nonAlgebraic's full-sized avatar
🍍

Sine Gadot nonAlgebraic

🍍
View GitHub Profile
@smably
smably / code-review.md
Last active February 10, 2022 14:14
How to Give a Great Code Review

How to Give a Great Code Review

Claim: A great code review is thorough, constructive, kind, and prompt.

Thorough

  1. Effective code review requires that you understand what the PR is trying to accomplish. If there is a ticket or issue associated with the PR, start by opening it and reading the acceptance criteria. Then read through the PR description. Think about how you might approach the problem if you had written the code yourself. What are the constraints? What are some edge cases you would want to watch out for? If you are unclear about any aspect of the problem the PR is solving, talk to the author to clarify before you start looking at their code.
  2. If the author has deployed their code to a QA environment, take some time to try out the new functionality. See whether the actual behaviour matches your assumptions. If not, go back and check the acceptance criteria. If you have any questions or you think you’ve found