|
| 1 | +<!-- |
| 2 | + <<< Author notes: Step 3 >>> |
| 3 | + Start this step by acknowledging the previous step. |
| 4 | + Define terms and link to docs.github.com. |
| 5 | + Historic note: this step combines the commend, approve, and needs changes steps from the previous version. |
| 6 | +--> |
| 7 | + |
| 8 | +## Step 3: Leave a review |
| 9 | + |
| 10 | +_You assigned yourself! :tada:_ |
| 11 | + |
| 12 | +Pull request reviews ensure quality and maintain momentum of changes to your project. |
| 13 | + |
| 14 | +#### When reviewing a pull request: |
| 15 | + |
| 16 | +1. Review the _title_ and _body_ of the pull request, and possibly any associated issue, to understand the intended change. |
| 17 | +1. Review the [diff](https://docs.github.com/en/get-started/quickstart/github-glossary#diff), the comparison of the proposed code, in the context of the whole project. |
| 18 | +1. For most things, try out the proposed change. Check if the actual change matches the intention. Find the repository's [contributing guide](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) to find out how to review the changes. |
| 19 | + |
| 20 | +#### In your review comments: |
| 21 | + |
| 22 | +- Identify potential issues, risks, and limitations. |
| 23 | +- Suggest changes and improvements. |
| 24 | +- Share awareness of upcoming changes that the pull request doesn't account for. |
| 25 | +- Ask questions to verify shared understanding. |
| 26 | +- Highlight what the author did well and should keep doing. |
| 27 | +- Prioritize the most important feedback. |
| 28 | +- Be concise _and_ provide meaningful detail. |
| 29 | +- Treat the pull request author with kindness and empathy. |
| 30 | + |
| 31 | +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. |
| 32 | + |
| 33 | +### :keyboard: Activity: Leave a review |
| 34 | + |
| 35 | +1. On the pull request, click **Files changed**. |
| 36 | +1. Click **Review changes**. |
| 37 | +1. Add a comment with your initial thoughts on the pull request. |
| 38 | +1. Select _comment_. You won't be able to _approve_ or _request changes_ to your own pull request. |
| 39 | +1. Click **Submit review**. |
| 40 | +1. Wait about 20 seconds then refresh this page (the one you're following instructions from). [GitHub Actions](https://docs.github.com/en/actions) will automatically update to the next step. |
0 commit comments