Skip to content

Pull requests and Code Reviews

Lori Bailey edited this page Jan 8, 2024 · 1 revision

Pull Requests and Code Reviews

Lucid board from January 2024 meeting with devs

PRs

Authors should

  • Provide relevant context for the changes, including Trello links, so reviewers can understand the scope of the changes

  • Include videos or screenshots

  • Ensure commit messages are descriptive and meaningful

  • Include links to relevant documentation, such as gems, repos, etc

  • Ask for reviews from the whole team only if the code is shared

  • Share a link to the PR in slack, so those who are not requested to review still can see what has been done or offer a review if they like.

Code reviews

Reviewers should

  • Make the intent of a comment clear – Do you just want to have a discussion, or do you want the author to make a change?

  • Request changes when there is a strong reason for not merging

  • Only approve after pulling the branch and testing locally

Authors should

  • Address all comments made by reviewers

  • Wait for a review from each team if the code is shared

Clone this wiki locally