Skip to content

013 — Code review

Code reviews are essential for the success of the project and are as important as contributing code.

Reviews are handled via GitHub pull requests. When the request is ready for review, the "status: code review" label is added to it.

A full list of pull requests that need review is available at GitHub.

Guidelines

  • Check out the pull request branch, open the project in the IDE, get a big picture.
  • Does the pull request make sense overall?
  • Run tests and/or application using code from the pull request. Are these OK?
  • Read all lines of code in the pull request.
  • Could it be done simpler?
  • Are there security issues?
  • Are there performance issues?
  • When leaving comments, be polite.
  • Avoid code-formatting comments.

Mandatory parts

  • Tests that fail without code and pass with code.
  • Type hints.
  • declare(strict_types=1).
  • Documentation: phpdoc, yiisoft/docs.
  • Changelog entry (if package is stable).