|
| 1 | +## Step 3: Leave a review |
| 2 | + |
| 3 | +_You assigned yourself! :tada:_ |
| 4 | + |
| 5 | +#### What is a pull request review? |
| 6 | + |
| 7 | +A **pull request review** is feedback from other collaborators or community members on the proposed changes. It helps ensure quality and project momentum. Even more importantly, it's an awesome opportunity to learn more about the project and grow as a developer by seeing how others approach the problem. |
| 8 | + |
| 9 | +Naturally, the best way to get a review is to ask for one. By assigning a reviewer, they get 3 options for providing feedback: |
| 10 | + |
| 11 | +- **Comment** - General feedback without approval or rejection. |
| 12 | +- **Approve** - Allows merging if [rulesets](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets), [code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners), or other policies are enforced. |
| 13 | +- **Request Changes** - The proposed changes need do not meet expectations and need additional work. A review should be re-requested after the changes are made. |
| 14 | + |
| 15 | +The **Files changed** tab is the primary place for collecting feedback. It allows for adding comments directly to lines before submitting a review. |
| 16 | + |
| 17 | +### What does a review typically look like? |
| 18 | + |
| 19 | +1. Reviewing the **title** and **description** are clear and concise. It should easily convey the intended changes and any associated issues. |
| 20 | + |
| 21 | +1. Reviewing the **Files changed** tab to ensure all proposed code matches the description. |
| 22 | + |
| 23 | +1. For most updates, try out the proposed change to verify they match the intention. |
| 24 | + |
| 25 | +1. Use the repository's [contributing guide](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors) for any guidance on review requirements, testing, quality verification, etc. |
| 26 | + |
| 27 | +#### Review ideas |
| 28 | + |
| 29 | +- Identify potential issues, risks, and limitations. |
| 30 | +- Suggest changes and improvements. |
| 31 | +- Share awareness of upcoming changes that the pull request doesn't account for. |
| 32 | +- Ask questions to verify shared understanding. |
| 33 | +- Highlight what the author did well and what they should keep doing. |
| 34 | +- Prioritize the most important feedback. |
| 35 | +- Be concise _and_ provide meaningful detail. |
| 36 | +- Treat the pull request author with kindness and empathy. |
| 37 | + |
| 38 | +### :keyboard: Activity: Leave a review |
| 39 | + |
| 40 | +1. On the pull request, click the **Files changed** tab. |
| 41 | + |
| 42 | +1. Take a moment to review the change. |
| 43 | + |
| 44 | + - Notice the change is a simple wording adjustment. |
| 45 | + |
| 46 | +1. Above the comparison view, click the **Review changes** button. |
| 47 | + |
| 48 | +1. Enter the following comment and click the **Submit review** button. |
| 49 | + |
| 50 | + ```md |
| 51 | + Looks good to me. I think this is more intuitive. Nice work! |
| 52 | + ``` |
| 53 | + |
| 54 | + > šŖ§ **Note:** You can't choose **Approve** or **Request changes** on your own pull request. |
| 55 | +
|
| 56 | +1. With your review submitted, Mona will check your progress and share the next steps. |
0 commit comments