Skip to content

Commit 1cb46ab

Browse files
Update to 4 in STEP and README.md
1 parent b2a0a61 commit 1cb46ab

File tree

2 files changed

+14
-29
lines changed

2 files changed

+14
-29
lines changed

.github/steps/-step.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3
1+
4

README.md

+13-28
Original file line numberDiff line numberDiff line change
@@ -14,44 +14,29 @@ _Collaborate and work together on GitHub._
1414
</header>
1515

1616
<!--
17-
<<< Author notes: Step 3 >>>
17+
<<< Author notes: Step 4 >>>
1818
Start this step by acknowledging the previous step.
1919
Define terms and link to docs.github.com.
20-
Historic note: this step combines the commend, approve, and needs changes steps from the previous version.
2120
-->
2221

23-
## Step 3: Leave a review
22+
## Step 4: Suggest changes
2423

25-
_You assigned yourself! :tada:_
24+
_Nice work reviewing that pull request :sparkles:_
2625

27-
Pull request reviews ensure quality and maintain momentum of changes to your project.
26+
Now that you have explored the different ways you can review a pull request it is time to learn how to use _suggest changes_.
2827

29-
#### When reviewing a pull request:
28+
**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.
3029

31-
1. Review the _title_ and _body_ of the pull request, and possibly any associated issue, to understand the intended change.
32-
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.
33-
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.
34-
35-
#### In your review comments:
36-
37-
- Identify potential issues, risks, and limitations.
38-
- Suggest changes and improvements.
39-
- Share awareness of upcoming changes that the pull request doesn't account for.
40-
- Ask questions to verify shared understanding.
41-
- Highlight what the author did well and should keep doing.
42-
- Prioritize the most important feedback.
43-
- Be concise _and_ provide meaningful detail.
44-
- Treat the pull request author with kindness and empathy.
45-
46-
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.
47-
48-
### :keyboard: Activity: Leave a review
30+
### :keyboard: Activity: Suggest changes
4931

5032
1. On the pull request, click **Files changed**.
51-
1. Click **Review changes**.
52-
1. Add a comment with your initial thoughts on the pull request.
53-
1. Select _comment_. You won't be able to _approve_ or _request changes_ to your own pull request.
54-
1. Click **Submit review**.
33+
1. Find the `index.html` changes.
34+
1. Hover your cursor next to the line numbers on the left side of the page.
35+
1. Click the blue plus icon.
36+
1. After the comment form appears, click the **Add a suggestion** button. <br>
37+
![add-a-suggestion-button](https://user-images.githubusercontent.com/97056108/184449714-61e8ee51-824a-48c1-9436-2dfd67f2c070.png)
38+
1. Edit the suggestion.
39+
1. Click **Add a single comment**.
5540
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.
5641

5742
<footer>

0 commit comments

Comments
 (0)