Skip to content

Instantly share code, notes, and snippets.

@kirang89

kirang89/checklist.md

Created November 5, 2013 16:39
Show Gist options
  • Save kirang89/7321904 to your computer and use it in GitHub Desktop.
Save kirang89/7321904 to your computer and use it in GitHub Desktop.
Download ZIP
Code review checklist
Raw
checklist.md

General

  • Standards/Conventions: Make sure that code follows the appropriate standards/conventions (ex: PEP8 for Python).
  • Appropriate names: Make sure that variables, arguments, functions, modules and packages are named appropriately.
  • Valid arguments: Make sure that all method arguments are valid ones.
  • Single responsibility: Make sure that every function/method used has a single responsibility.
  • Disposable Resources: Make sure that temporary resources are terminated after their use (ex: opening a file to read content).
  • Security: Make sure no critical data or sensitive information is exposed in any way to the public. This involves both client-side as well as the server-side code (ex: storing a raw password to db)

.......

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment