GitHub Code Review Template (WIP)

Guidelines

• PRs should be reviewed and approved within 2 working days
• Draft PRs should not be reviewed
• Automated tools should have the sole responsibility for enforcing code style

---

Submission Template

Change type

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

Readiness

• Unit tests pass
• Linter pass
• Formatter pass
• Spell check pass
• Static analyzer pass
• Code quality analysis pass (ie. SonarQube)
• Affected platforms
  • All
  • iOS
  • macOS
  • watchOS
  • tvOS
  • visionOS

---

Review Template

Concern

• Fault
• Security
• Leak
• Performance
• Typo (non-blocking)
• Style (non-blocking)

Level of concern

• Blocking
• Expected (non-blocking)
• Nice to have (non-blocking)
• Suggestion (non-blocking)

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.