Skip to content

Instantly share code, notes, and snippets.

Code Review Guidelines

These are just what it says: guidelines. When reviewing code, this is the vague problem space of issues to watch for. Every guideline may have exceptions, for author and reviewer to discuss and come to an agreement on.

Function

  • Does the code compile?
  • Have unavoidable warnings been suppressed and explained in comments?
  • Does the code have passing tests?
  • Do the unit tests actually test all of the business logic, including edge cases?
  • Does the code accomplish the business requirements (or fix the bug)? Does it only accomplish the requirements (no extra functionality)?

Keybase proof

I hereby claim:

  • I am imnotpete on github.
  • I am imnotpete (https://keybase.io/imnotpete) on keybase.
  • I have a public key whose fingerprint is 3D6D 6218 0ABF 110E A723 D714 E4D8 B99F F1FB AB9B

To claim this, I am signing this object:

CmdUtils.CreateCommand({
names: ["goto"],
icon: "http://www.mozilla-europe.org/favicon.ico",
homepage: "http://www.google.com/",
author: { name: "Jan S", email: "neonsamurai@hotmail.com"},
license: "GPL",
description: "url to navigate to",
help: "Type any url to open in a new tab...",
arguments: [ {role: "object", nountype: noun_arb_text, label: "url"}],