Skip to content

Instantly share code, notes, and snippets.

@habedi

habedi/code_review_principles.md

Created July 24, 2025 08:37
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save habedi/b0a6aa5f08f8df028e9e949efbd72064 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save habedi/b0a6aa5f08f8df028e9e949efbd72064 to your computer and use it in GitHub Desktop.
Download ZIP
Code Review Principles
Raw
code_review_principles.md

Code Review Principles

  1. Don't write comments based on opinion or gut feeling. Have a reason. If possible, back it up with a reference (style guide, docs, performance data, etc).

  2. Write full sentences and don’t leave out context. Be clear so the reader doesn’t have to guess what you mean.

  3. Avoid vague "why?" questions. If something is not clear, ask for clarification in a specific way. If something needs changing, suggest the change and explain why.

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