Skip to content

Latest commit

 

History

History
230 lines (160 loc) · 11.1 KB

README.md

File metadata and controls

230 lines (160 loc) · 11.1 KB
Raw

Review pull requests

Collaborate and work together on GitHub.

Step 1: Assign yourself as a reviewer

Welcome to "Review pull requests"! 👋

What is a pull request review?: Reviewing a pull request is an opportunity to examine another contributor's changes and give them feedback. It's an awesome opportunity to learn more about how the project works and how others solve problems.

The best way to get a review is to ask for one. On GitHub, you can ask someone to review a pull request by assigning them as a reviewer. If you are not ready for review, consider creating a draft pull request instead.

⌨️ Activity: Assign yourself as a reviewer

  1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
  2. We made a pull request for you from the update-game branch, so open that pull request.
  3. Under Reviewers on the right side of the screen, add yourself as a reviewer.

Next, wait about 20 seconds for actions to run, then refresh this course's README (the one you're following instructions from) and a GitHub Action will automatically close this step and open the next one.

Step 2: Leave a review

You assigned yourself as a reviewer! 🎉

Pull request reviews ensure quality and maintain momentum of changes to your project.

When reviewing a pull request:

  1. Review the title and body of the pull request, and possibly any associated issue, to understand the intended change.
  2. Review the diff, the comparison of the proposed code, in the context of the whole project.
  3. For most things, try out the proposed change. Check if the actual change matches the intention. Find the repository's contributing guide to find out how to review the changes.

In your review comments:

  • Identify potential issues, risks, and limitations.
  • Suggest changes and improvements.
  • Share awareness of upcoming changes that the pull request doesn't account for.
  • Ask questions to verify shared understanding.
  • Highlight what the author did well and should keep doing.
  • Prioritize the most important feedback.
  • Be concise and provide meaningful detail.
  • Treat the pull request author with kindness and empathy.

When an approval or request for changes is not yet needed, consider using comments. An approval lets the author know you believe the pull request is safe to merge. Requesting changes lets the author know you believe the pull request is not ready to merge.

⌨️ Activity: Leave a review

  1. On the pull request, click Files changed.
  2. Click Review changes.
  3. Add a comment with your initial thoughts on the pull request.
  4. Select comment, approve, or request changes: any option will work.
  5. Click Submit review.

Next, wait about 20 seconds for actions to run, then refresh this course's README (the one you're following instructions from) and a GitHub Action will automatically close this step and open the next one.

Step 3: Suggest changes

Nice work reviewing that pull request ✨

Now that you have explored the different ways you can review a pull request it is time to learn how to use suggest changes.

What is suggest changes?: This feature enables you to recommend a change to a pull request that the author can commit with the push of a button.

⌨️ Activity: Suggest changes

  1. On the pull request, click Files changed.
  2. Find the index.html changes.
  3. Hover your cursor next to the line numbers on the left side of the page.
  4. Click the blue plus icon.
  5. After the comment form appears, click the Add a suggestion button.
    add-a-suggestion-button
  6. Edit the suggestion.
  7. Click Add a single comment.

Next, wait about 20 seconds for actions to run, then refresh this course's README (the one you're following instructions from) and a GitHub Action will automatically close this step and open the next one.

Step 4: Apply suggested changes

Nicely done suggesting changes! 🥳

Now let's see how easy it is to apply your suggestion.

⌨️ Activity: Apply suggested changes

  1. Click Commit suggestion.
  2. Type a commit message.
  3. Click Commit changes.

Next, wait about 20 seconds for actions to run, then refresh this course's README (the one you're following instructions from) and a GitHub Action will automatically close this step and open the next one.

Step 5: Merge your pull request

Almost there! ❤️

You can now merge your pull request!

⌨️ Activity: Merge your pull request

  1. Click Merge pull request.
  2. Delete the branch update-game (optional).

Next, wait about 20 seconds for actions to run, then refresh this course's README (the one you're following instructions from) and a GitHub Action will automatically close this step and open the next one.

Finish

Congratulations friend, you've completed this course!

celebrate

As you continue working on GitHub, remember that high quality reviews improve your projects. If you are new to a repository, inquire about what review practices they have so you can hit the ground running.

Here's a recap of all the tasks you've accomplished in your repository:

  • You learned how to assign pull requests for review.
  • You left a review on a pull request.
  • You suggested changes to a pull request.
  • You applied suggested changes to a pull request.

What's next?

Get help: Post in our discussion board • Review the GitHub status page

© 2022 GitHub • Code of Conduct • CC-BY-4.0 License