Code Review Rubrics

Each pull request should be reviewed with the 5 following criteria in mind:

1. Correctness
2. Readability
3. Efficiency
4. Style
5. Documentation

In addition to reviewing code on Github, branches under review should also be fetched and tested locally. Reviews should be completed file by file, and each file should be marked as checked on the Github review page upon being reviewed.

The conditions for approval of each criterion will be outlined below. Pull requests should only be approved and merged if the approval conditions for all criteria are met.

Correctness

• No errors(type error, lint error, etc)
• [Features] Feature works as specified
• [Bugs] Bug is actually fixed as specified
• Functionality of the rest of the application unaffected by the code changes

Readability

• Indentation used is consistent
• Blank lines are used to separate distinct sections of code
• Variable names are meaningful
• Code is well organized
  • Types are all defined in one section at the top of the file
  • Import statements should be organized at the top by Components, Hooks, Helpers, Types, Constants or other categories as necessary
  • Reusable logic is extracted into helper functions

Efficiency

• Loops are used instead of repeating steps
• Reusable helper functions and components are used instead of copying or rewriting code
• No slow asynchronous loops implemented - use Promise.all() instead
• Make use of available abstractions where applicable

Style (References: Style Guide, Git Workflow)

• Coding and Git conventions are strictly adhered to
• Best Practices are followed as closely as possible

Documentation

• Sections of code which employ complex logic should be well commented
• Newly exposed endpoints should be properly reflected in the backend wiki