code-review.md

Code Review

• How to Make Your Code Reviewer Fall in Love with You

  • Tips on how to prepare for a review.

• Maslow's pyramid of code review

  • Correct
  • Secure
  • Readable
  • Elegant
  • Altruist

• No code reviews by default

  • How we built an engineering culture based on trust that allows us to move incredibly fast without requiring code reviews
  • Make your own rules

• Ship / Show / Ask

  • Use judgement and autonomy to judge when a code review is needed

• Makes me think of code reviews and gym class

  • You cannot humiliate people into excellence

• conventional: comments #comments

  • Comments that are easy to grok and grep
  • [technical-language]

• Best practices for writing code comments #comments

  • Rule 1: Comments should not duplicate the code.
  • Rule 2: Good comments do not excuse unclear code.
  • Rule 3: If you can’t write a clear comment, there may be a problem with the code.
  • Rule 4: Comments should dispel confusion, not cause it.
  • Rule 5: Explain unidiomatic code in comments.
  • Rule 6: Provide links to the original source of copied code.
  • Rule 7: Include links to external references where they will be most helpful.
  • Rule 8: Add comments when fixing bugs.
  • Rule 9: Use comments to mark incomplete implementations.