search

wbent22 / reviewing-a-pull-request

https://lab.github.com/githubtraining/reviewing-pull-requests
MIT License
0 stars 0 forks source link

Change Tetris Colors #3

Closed github-learning-lab[bot] closed 3 years ago

github-learning-lab[bot] commented 3 years ago

Using request changes on a pull request

Thanks again for all your help on that last pull request. With our powers combined, anything is possible! This next change might introduce some new changes that aren't going to look great.

Sometimes, the author might identify that something isn't working. They might need a helping hand :wave: to solve the problem. In other instances, it might only work in their environment. When reviewing a pull request, look at and test the code to pinpoint any bugs or unexpected behavior.

Writing a review

Review the diff

Reviewing the diff, the comparison of the proposed code, in the context of the whole project. Could it introduce performance problems, or security vulnerabilities? Try to predict unintended consequences that this change could cause.

Try it out

For most things, actually trying out the proposed change is a good idea. This makes it a lot easier to tell if the actual change matches the intention. You can do this by:

When summarizing your review, let the author know if you completed any of these tests.

Empathy and Constructive Feedback

The goal of providing feedback on a pull request is to ensure that the best possible change is being added. Sometimes, a change isn't addressing the problem in the best possible way. It's the reviewer's responsibility to provide meaningful and constructive feedback.

Requesting Changes 101

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 and its pending comments, scroll down to the end of the page in the Conversation tab. Then click Cancel review.

Step 4: Leave a review that asks for changes

If you could check out this code for me and tell me what is wrong, that would be fantastic.

:keyboard: Activity: Requesting changes

  1. On the pull request, click Files changed
  2. Hover over the line of code where you'd like to add a comment, and click the blue comment icon
  3. In the comment window, type your comment
  4. Click Start a review
    • If you have already started a review, you can click Add review comment
  5. Above the changed code, click Review changes
  6. Type a comment summarizing your feedback on the proposed changes
    • Note: The problem here is that too many Tetris pieces are the same color. In your review, you might want to suggest that I choose colors which would be easier to see when playing the game.
  7. Select Request changes to submit feedback introducing changes necessary before merging
  8. Click Submit review

Return to this pull request for my next comment

Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response, wait a few seconds and refresh the page for your next steps.

github-learning-lab[bot] commented 3 years ago

Requesting changes

Thanks for making that suggestion on my change. In my excitement to ship more stuff, I must have gotten distracted while picking colors. :grimacing: I'm making a change to this branch to fix my mistake.

Not all the pull request reviews you perform in the future will decide the color of the blocks in our Tetris game. :smile:

Although you may want to leave short comments like: 👍, 👎🏽, awesome!, or no; these don't give the author much detail. Provide comments like the following to enable the author of the pull request to respond:

Step 5: Practice reviews

While you were reading this, I made your suggested changes. If you could approve my pull request, that would be awesome!

:keyboard: Activity: Give another pull request review

  1. In the pull request, scroll down to the bottom and look for your own review status
  2. Next to your review, click Approve changes

Return to this pull request for my next comment

Sometimes I respond too fast for the page to update! If you perform an expected action and don't see a response, wait a few seconds and refresh the page for your next steps.

github-learning-lab[bot] commented 3 years ago

Step 8: Don't just review, suggest!

Now that you have explored the different ways you can review a pull request it is time to learn how to use the suggest changes functionality. This feature, enables you to recommend a change to a pull request that the author can commit with the push of a button!

:keyboard: Activity: Create a pull request

  1. Create a pull request using the base: main and compare: update-readme branches

Click here to start the pull request