Review Process

1. Reviewer: Perform 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 must perform the review. GitHub Docs: Reviewing proposed changes in a pull request provides more information.

2. Reviewer: Submit the review

Submit the review to the developer by the requested date. GitHub Docs: Submitting your review provides more information.

3. Developer: Respond to each review comment

Once the developer receives notification that a review has been submitted, the developer must respond to each review comment:

• if the developer makes changes in response to a review comment, reply to the comment with a link to the commit containing the change:
  • related changes, e.g. typos, can be made via a single commit.
  • 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. GitHub Docs: Commit SHAs provides more information.
• if no changes are made in response to a review comment, the developer must reply to the comment to explain the reasons behind the decision not to make a change

Important

By adding a link to the commit containing the change made in response to a review comment, the reviewer will be able to quickly identify the change made, which will speed up the review process.

Important

The developer must not select the Resolve conversation button; only the reviewer selects this button when they are happy that their review comment has been resolved.

Note

If the developer accepts a suggested change from the reviewer, the conversation is automatically resolved by the developer. This is the only time the developer resolves a conversation.

4. Developer: Re-request a review

Once the developer has responded to each review comment, the developer must re-request a review. GitHub: Re-requesting a review provides more information.

5. Reviewer: Respond to each review comment response

Once the reviewer receives notification that a PR is ready for re-review, the reviewer must respond to each review comment response by either:

• approving the review comment response by selecting the Resolve conversation button. GitHub Docs: Resolving conversations provides more information.
• submitting 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 Issue to make the change.

6. Reviewer: Approve the PR

Steps 2. to 5. must be repeated until the reviewer has resolved all conversations.

Once the reviewer has approved all changes, the reviewer must approve the PR. GitHub Docs: Approving a pull request with required reviews provides more information.

The PR is automatically moved from the "In review" column to the "Approved" column when the PR has been approved.

Important

The developer merges the PR.