Skip to content

Instantly share code, notes, and snippets.

@oisin

oisin/codereview.md

Created August 29, 2014 08:08
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 oisin/56f078c17ace411f25e3 to your computer and use it in GitHub Desktop.
Save oisin/56f078c17ace411f25e3 to your computer and use it in GitHub Desktop.
Download ZIP
code-review
Raw
codereview.md

This is a summary of an original prose piece

Author

  • Patches to be kept as small as practicable
  • Patches to be explained clearly

Reviewer

  • What is the intent of the patch?
  • Is the change being made in the right place?
  • Does the change do what it is meant to do? Tests to prove, documentation to explain.
  • Is the grammar, naming schemes appropriate?

Output

  • TODOs - changes must be done before merge
  • Questions - may not require changes
  • Suggestions - not quite relevant to the patch, but potentially useful
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment