Skip to content

Latest commit

 

History

History

code-review

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

Code Review

A guide for reviewing code and having your code reviewed.

Everyone

  • Ask questions, don't make demands.
  • Ask for clarification.
  • Be explicit.
  • Don't use sacrasm.
  • Talk synchronously (chat, in person) if there are too many "I did't understan" o "Alternative solution:". Post a follow up comment summarizing the discussion.

Having your code reviewed

  • Don't take it personally.
  • Explain why the code exists.
  • Try to respond to every comment.
  • Merge request once you feel confident in the code.

Reviewing code

  • Identify ways to simplify the code while still solving the problem.
  • Offer alternative implementations.
  • Seek to understand the author perspective.
  • Sign off the pull request with a 👍 or a "Ready to merge" comment.