Pull Request Review Checklist

Commit Message

• Does commit message format follow team's convention?

Branch

• Does the branch name follow team's convention?
• Has it been rebased from develop branch?

PR Description

• Does it follow team's convention?
• Does it contain typos?
• Is the How should this be manually tested? section correct and can it be followed as described?
• Is the Pivotal Tracker link valid?

API

• Does the endpoint work as expected based on the story's specification?
• Does the documentation follow team's convention?
• Does the documentation cover all the status codes mentioned in story's board?
• Are the examples provided correct?

Tests

• Are the tests passing both locally and on Travis ci?
• Do the tests cover all possible corner cases? Think about it.
• If a model was added to the database,
  • Are there tests for the model?

Code

• Are there repetitions that could have been abstracted away?
• Are there unnecessary code snippets that could have taken advantage of an existing implementation?
• Are there implementations that could have used team's conventions?
  • Error/success messages not in designated sections
• Are there inefficient code sections that can be improved?
• Are there function, variable and class names that could be more descriptive?
• Are there unclear code sections that could use helpful comments?
• If a model was added to the database,
  • Is the migration file added?
• If a model was updated,
  • Has the migration file been updated as well?
• Are there issues pointed out by CodeClimate that needs to be fixed?
• Does the PR reduce total-coverage on CodeClimate?

N.B

Do not just LGTM. Instead, do the following:

• Test the code locally with docker
• Review the code to see if it follows the team's conventions
• Acknowledge PR by approving it