Skip to content

Instantly share code, notes, and snippets.

@HaMster21
Forked from haacked/code-review-checklist.md
Last active August 29, 2015 14:03
Show Gist options
  • Select an option

  • Save HaMster21/c9648b150acca0b9bf31 to your computer and use it in GitHub Desktop.

Select an option

Save HaMster21/c9648b150acca0b9bf31 to your computer and use it in GitHub Desktop.
common questions to keep in mind when publishing changes to code

General

  • Unit tests Is the code tested? Are the tests showing the intention how to use the code? Are there gaps that also need testing? Is the expected behavior clear?
  • Method arguments Make sure arguments to methods make sense and are validated.
  • Null References (Yah yah, we know. Use F# and this goes away. We get it already.) Null references are a bitch and it’s worth looking out for them specifically.
  • Conventions Consistency Make sure naming, formatting, etc. follow our conventions and are consistent. I like a codebase that’s fairly consistent so you know what to expect.
  • Disposables Make sure disposable things are disposed. Look for usages of resources that should be disposed but are not.
  • Security: There is a whole threat and mitigation review process that falls under this bucket.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment