Reviewing a Pull Request

About Reviewing a Pull Request

Reviews allow collaborators to comment on the changes proposed in pull requests, approve the changes, or request further changes before the pull request is merged. Repository administrators can require that all pull requests are approved before being merged.

After a pull request is opened, anyone with_read_access can review and comment on the changes it proposes. Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository.

A review has three possible statuses:

  • Comment: Submit general feedback without explicitly approving the changes or requesting additional changes.
  • Approve: Submit feedback and approve merging the changes proposed in the pull request.
  • Request changes: Submit feedback that must be addressed before the pull request can be merged.

Creating a Review

  1. Under your repository name, click Pull requests.

2) In the list of pull requests, click the pull request you'd like to review.\

3) On the pull request, click Files changed.

4) Hover over the line of code where you'd like to add a comment, and click the blue comment icon.

5) In the comment window, type your comment. When you're done, click Start a review. If you have already started a review, you can click Add review comment.

Before you submit your review, your line comments are _pending _and only visible to you. You can edit pending comments anytime before you submit your review. To cancel a pending review, including all of its pending comments, scroll down to the end of the timeline on the Conversation tab, then click Cancel review.

Submitting your review

After you've finished reviewing the proposed changes in the pull request, submit your review.

  1. On the pull request, click Files changed.

2) Above the changed code, click Review changes.

3) Type a comment summarizing your feedback on the proposed changes.

4) Select the type of review you'd like to leave:

  • Select Comment to leave general feedback without explicitly approving the changes or requesting additional changes.
  • Select Approve to submit your feedback and approve merging the changes proposed in the pull request.
  • Select Request changes to submit feedback that must be addressed before the pull request can be merged.

5) Click Submit review.

results matching ""

    No results matching ""