Skip to content

Instantly share code, notes, and snippets.

View brianzhou13's full-sized avatar

Brian Zhou brianzhou13

20 followers · 54 following
  • NY
View GitHub Profile
@brianzhou13
brianzhou13 / PR_review_notes.md
Created July 31, 2020 13:26

REVIEWING CODE:

  • If possible, before the review, talk to the requester for 5 minutes to get a bit of a preview of the code. This helps you get a mental understanding of what you are reviewing.

  • Teach, don't just tell. Reviewing a PR shouldn't JUST be about code safety, but also an opportunity to mentor as well.

  • Don't forget to praise concise/readable/efficient/elegant code.
  • Remember that you are reviewing another human's code. Ask, don't tell.
@brianzhou13
brianzhou13 / PR_review_template.md
Last active December 31, 2022 23:17

FEATURE_NAME

  • PR_LINK

What goal does this code accomplish?

this might be the "What problem are you solving" section of a PR

How does it accomplish this goal?

this might be the "How did you solve it" section of a PR