jwood803
10/28/2013 - 8:40 PM

Code Review Checklist

Code Review Checklist

code-review-checklist.md
content_copyfile_download
  • Rendered
  • Source

General

  1. Unit tests: Review unit tests first. Unit tests are a fantastic way to grasp how code is meant to be used by others and to learn what the expected behavior is. Are there any test gaps that should be there?
  2. Method arguments" Make sure arguments to methods make sense and are validated. Mentally test boundary conditions and edge cases.
  3. 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.
  4. 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.
  5. Disposables: Make sure disposable things are disposed. Look for usages of resources that should be disposed but are not.
  6. Security: There is a whole threat and mitigation review process that falls under this bucket. In simple terms, ask yourself how this code could be exploited. The STRIDE Threat Model contains a list of potential threats to consider.

C# Library Code

  1. async keyword Review library methods that use the async keyword to see if they actually need it as it can introduce extra uncessary cost. See this gist for an example.
  2. async void methods These are a red flag and should probably return Task. See this post for more information.
  3. ConfigureAwait(false) Library methods that return Task should also call ConfigureAwait(false). See this article for more details.

WPF + ReactiveUI

  1. Updating UI: Make sure view model properties are updated on the main scheduler (UI thread). This is because we bind the UI to these properties and the UI can only be updated on the UI thread.
  2. ObserveOn: When kicking off truly async operations, make sure we ObserveOn(RxApp.DeferredScheduler) soon after (related to previous).
  3. Over subscriptions: Make sure we're not over subscribing to deferred observables etc that could lead to multiple operations.
  4. ???

JavaScript (Electron App)

  1. ??? (Please help!)