Skip to content

GitHub Code Review Template (WIP)

Jump to bottom
Marc Lavergne edited this page Sep 11, 2023 · 5 revisions

Guidelines

  • Disable PR auto assignment [Organization > Teams > Settings > Enable auto assignment > Uncheck]
  • Goal is to have PRs reviewed and approved within 2 working days
  • Draft PRs should not be reviewed
  • Automated tools have the ultimate responsibility for enforcing code style

Submission Template

Change type

  • Feature
  • Enhancement
  • Bugfix (non-functional change)
  • Refactor (non-functional change)
  • Tests (non-functional change)

Readiness

  • Self reviewed
  • Unit tests pass
  • Linter pass
  • Formatter pass
  • Spell check pass
  • Static analyzer pass
  • Code quality analysis pass (ie. SonarQube)
  • Tested on
    • iOS
    • macOS
    • watchOS
    • tvOS
    • visionOS

Review Template

Concern (critical to minor)

  • Regression
  • Security
  • Resource Leak
  • Performance
  • Test Coverage
  • Documentation (non-blocking)
  • Style (non-blocking)
  • Typo (non-blocking)

Level of concern (high to low)

  • Blocking (ie. regression or breaks specification)
  • Expected (ie. incomplete or missing code)
  • Important (ie. tangible improvement)
  • Nice to have (ie. inconsequential or nitpick)

What should be changed?

Explanation

What should it be changed?

Explanation

If there are no blocking comments, or all blocking comments have been addressed, the reviewer should approve the PR and the author is responsible for addressing non-blocking concerns.

Clone this wiki locally