Review Process

Reviewer: Perform and submit the review

• Once the reviewer receives notification (<developer> requested your review on: #<issue_number>) that a pull request (PR) is ready for review, the reviewer should perform and submit a review, see GitHub: Reviewing proposed changes in a pull request

Developer: Respond to each review comment

• Once the developer receives notification that a review has been submitted, the developer should respond to each review comment:
  • if changes are made in response to a review comment, reply to the comment with a link to the commit containing the change
    • Changes can be committed to the branch and pushed at any time after the PR has been created; the PR will update automatically
    • The shortened SHA renders as a link automatically in comments, see GitHub: Commit SHAs
  • if no changes are made, reply to the comment to explain the reasons behind the decision not to make a change
  • the developer should not click the Resolve conversation button; only the reviewer should click this button when they approve the changes related to that review comment
• Once the developer has responded to each review comment, the developer should re-request a review, see GitHub: Re-requesting a review

Reviewer: Re-perform and submit the review

• The reviewer should either:
  • approve the change related to the review comment by clicking the Resolve conversation button, see GitHub: Resolving conversations
  • submit additional review comments
• If the developer and the reviewer agree that responding to a review comment would create an excessively large or unrelated change (taking into consideration that smaller changes may not be worked on if the change is postponed), open a new software task to make the change

Reviewer: Approve the PR

1. The above steps should be repeated until the reviewer has approved all changes
2. Once the reviewer has approved all changes, the reviewer should approve the PR, see GitHub: Approving a pull request with required reviews

Developer: Merge the feature branch into main

1. Once the developer receives notification that the PR has been approved, the developer should merge the feature branch into main (see Wiki: Detailed Development Workflow: Merge the feature branch into develop)