From ae19e5cab030423c31eb8cb43c2d096b0254817a Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 3 Jan 2024 17:39:47 +0000 Subject: [PATCH] Update to 3 in STEP and README.md --- .github/steps/-step.txt | 2 +- README.md | 35 ++++++++++++++++++++++++++--------- 2 files changed, 27 insertions(+), 10 deletions(-) diff --git a/.github/steps/-step.txt b/.github/steps/-step.txt index 0cfbf08..00750ed 100644 --- a/.github/steps/-step.txt +++ b/.github/steps/-step.txt @@ -1 +1 @@ -2 +3 diff --git a/README.md b/README.md index 7568d4c..328e389 100644 --- a/README.md +++ b/README.md @@ -14,27 +14,44 @@ _Collaborate and work together on GitHub._ -## Step 2: Assign yourself +## Step 3: Leave a review -_Great job opening that pull request! :wave:_ +_You assigned yourself! :tada:_ -**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. +Pull request reviews ensure quality and maintain momentum of changes to your project. -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 or assignee. If you are not ready for review, consider [creating a draft pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) instead. +#### When reviewing a pull request: -### :keyboard: Activity: Assign yourself +1. Review the _title_ and _body_ of the pull request, and possibly any associated issue, to understand the intended change. +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. +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. -1. Open the pull request you just created. -1. Under **Assignees** on the right side of the screen, add yourself. +#### In your review comments: - Because you created the pull request, you can't assign yourself as a reviewer, but feel free to assign a friend as a reviewer instead to see how it works :smile: +- 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. + +### :keyboard: Activity: Leave a review + +1. On the pull request, click **Files changed**. +1. Click **Review changes**. +1. Add a comment with your initial thoughts on the pull request. +1. Select _comment_. You won't be able to _approve_ or _request changes_ to your own pull request. +1. Click **Submit review**. 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.