Skip to content

Commit 9d4440e

Browse files
FidelusAleksanderchriswblakeNicoleDev021
authored
refactor: rewrite the exercise with issue based flow (#108)
Co-authored-by: Christopher W. Blake <chriswblake@github.com> Co-authored-by: Madison Nicole Goodwin <217474974+NicoleDev021@users.noreply.github.com>
1 parent 76d6a1e commit 9d4440e

29 files changed

+640
-706
lines changed

ā€Ž.github/steps/-step.txtā€Ž

Lines changed: 0 additions & 1 deletion
This file was deleted.

ā€Ž.github/steps/0-welcome.mdā€Ž

Lines changed: 0 additions & 1 deletion
This file was deleted.

ā€Ž.github/steps/1-open-a-pull-request.mdā€Ž

Lines changed: 0 additions & 27 deletions
This file was deleted.

ā€Ž.github/steps/1-step.mdā€Ž

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Step 1: Open a pull request
2+
3+
_Welcome to "Review pull requests"! :wave:_
4+
5+
Let's get started by opening a **pull request** on some changes that were recently added to the `update-game` branch.
6+
7+
### What is a pull request?
8+
9+
A **pull request** is a collaboration area where work in one branch is reviewed before merging it into another branch. It has different tabs to manage the conversation and easily review changes.
10+
11+
- **Conversation** - A general log of the pull request activity. It also provides an open space for fellow collaborators and the community to provide ideas, suggestions, and general feedback.
12+
- **Commits** - A list of only the commits unique to the proposed branch.
13+
- **Checks** - The results of any automations applied to the pull request using [GitHub Actions](https://github.com/features/actions). That's for another exercise, though. šŸ˜Ž
14+
- **Files Changed** - A [Diff](https://docs.github.com/en/get-started/quickstart/github-glossary#diff) view that easily shows the proposed changes in a before/after view. It also has options to add comments and reviews in context.
15+
16+
> [!TIP]
17+
> You can [create 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) for unfinished work. This can help avoid accidental merges or premature reviews.
18+
19+
### :keyboard: Activity: Create a pull request
20+
21+
1. Open this repository in a new browser tab so you can work on the steps while you read the instructions in this tab.
22+
23+
1. In the top navigation, select the **Pull requests** tab.
24+
25+
1. On the right, click the **New pull request** button.
26+
27+
1. Under the **Compare changes** area, select the following options and click the **Create pull request** button.
28+
29+
- **base:** `main`
30+
- **compare:** `update-game`
31+
32+
1. Set the **title** and **description** to the following.
33+
34+
```md
35+
Update game over message
36+
```
37+
38+
```md
39+
Update the game over message so people know how to play again!
40+
```
41+
42+
1. Click **Create pull request**.
43+
44+
1. With the pull request created, Mona will check your progress and share the next steps.

ā€Ž.github/steps/2-assign-yourself.mdā€Ž

Lines changed: 0 additions & 23 deletions
This file was deleted.

ā€Ž.github/steps/2-step.mdā€Ž

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Step 2: Assign yourself
2+
3+
_Great job opening that pull request! :wave:_
4+
5+
#### What is an assignee?
6+
7+
A **pull request assignee** is the person (or persons) most familiar with the proposed changes.
8+
It's a simple mechanism for keeping track of who to contact for questions.
9+
10+
### :keyboard: Activity: Assign yourself
11+
12+
1. Navigate back to the created pull request if you are not on it.
13+
14+
1. On the right side, under **Assignees**, click the **assign yourself** text.
15+
16+
1. After assigning yourself, Mona will check your progress and share the next steps.

ā€Ž.github/steps/3-leave-a-review.mdā€Ž

Lines changed: 0 additions & 40 deletions
This file was deleted.

ā€Ž.github/steps/3-step.mdā€Ž

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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.

ā€Ž.github/steps/4-step.mdā€Ž

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Step 4: Suggest changes
2+
3+
_Nice work reviewing that pull request :sparkles:_
4+
5+
While reviewing, it is very common to find simple changes that are easier to implement than to describe. For example, typos or rewording sentences. These are perfect situations for the **Add a suggestion** feature.
6+
7+
### How do I suggest a change?
8+
9+
The **Add a suggestion** feature is a button in the comment text editor. It inserts a specially formatted code block. Instead of only showing a comment, GitHub will also provide a **Commit changes** button. This allows the author to accept the suggestion and commit it with the push of a button. No need to open a code editor! Nice!
10+
11+
### :keyboard: Activity: Suggest changes
12+
13+
1. On the pull request, click **Files changed**.
14+
15+
1. Find the comparison view for the `index.html` file.
16+
17+
1. Hover your cursor next to the line numbers for the modified line.
18+
19+
1. Click the plus icon to show an inline comment form.
20+
21+
1. Click the **Add a suggestion** button to insert a modifiable copy of the line.
22+
23+
<img width="300" alt="add-a-suggestion-button" src="https://github.com/user-attachments/assets/dc781d29-d5fe-4da9-9e4b-eb406c5d9ab5" />
24+
25+
1. Edit the suggestion to match below and click the **Add a single comment** button.
26+
27+
````md
28+
```suggestion
29+
<h2 hidden>Game over! Want to play again?! Just click refresh. šŸ§‘ā€šŸš€!</h2>
30+
```
31+
Let's make it a bit more friendly. šŸ¤“
32+
````
33+
34+
### :keyboard: Activity: Apply a suggested change
35+
36+
1. Click the **Commit suggestion** button to open a commit message form.
37+
38+
1. Edit the commit message to the below text and click the **Commit changes** button.
39+
40+
```markdown
41+
Make the end game experience more friendly
42+
```
43+
44+
1. With the changes committed, Mona will check your progress and share the next steps.

ā€Ž.github/steps/4-suggest-changes.mdā€Ž

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
Ā (0)
⚔