generated from skills/exercise-template
-
Notifications
You must be signed in to change notification settings - Fork 231
feat: migrate exercise to issue-based flow #85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
+609
−702
Closed
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
d02a51a
feat: draft migration to issue-based
chriswblake 885b62c
fix: incorrect description in copy button
chriswblake 25ec11b
fix: wrong trigger for workflow 6
chriswblake 16a1e99
fix: remove extra job in 'needs'
chriswblake 867dcc5
feat: Adjustments to include more learning material. Combines steps 4…
chriswblake 8858881
fix: incorrect trigger for step 4
chriswblake 76db17e
chore: wording tweaks from practice run
chriswblake b2772ab
chore: wording tweaks from practice run
chriswblake f213d64
feat: Remove link to discussions area
chriswblake 49bae18
fix: Change url to point at skills website instead of org
chriswblake 9a693d5
Update README.md course references
FidelusAleksander 552c396
Test run fixes, typos
FidelusAleksander 6183b0b
fix: incorrect owner in button
chriswblake aac5a12
chore: Cleanup several typos and sentences. Simplify file names. (#1)
NicoleDev021 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,44 @@ | ||
| <!-- | ||
| <<< Author notes: Step 1 >>> | ||
| Choose 3-5 steps for your course. | ||
| The first step is always the hardest, so pick something easy! | ||
| Link to docs.github.com for further explanations. | ||
| Encourage users to open new tabs for steps! | ||
| --> | ||
|
|
||
| ## Step 1: Open a pull request | ||
|
|
||
| _Welcome to "Review pull requests"! :wave:_ | ||
|
|
||
| Let's get started by opening a pull request. | ||
| Let's get started by opening a **pull request** on some changes that were recently added to the the `update-game` branch. | ||
|
|
||
| ### What is a pull request? | ||
|
|
||
| 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. | ||
|
|
||
| - **Conversation** - A general log of the pull request activity. It also provides open space fellow collaborators and the community to provide ideas, suggestions, and general feedback. | ||
| - **Commits** - A list of only the commits unique to the proposed branch. | ||
| - **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. 😎 | ||
| - **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 options to add comments and reviews in context. | ||
|
|
||
| **What is a pull request?**: Collaboration happens on a pull request. The pull request shows the changes in your branch to other people. This pull request is going to keep the changes you just made on your branch and propose applying them to the `main` branch. | ||
| > [!TIP] | ||
| > 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. | ||
|
|
||
| ### :keyboard: Activity: Create a pull request | ||
|
|
||
| 1. Click on the **Pull requests** tab in your repository. | ||
| 2. Click **New pull request**. | ||
| 3. In the **base:** dropdown, make sure **main** is selected. | ||
| 4. Select the **compare:** dropdown, and click `update-game`. | ||
| 5. Click **Create pull request**. | ||
| 6. Enter a title for your pull request: `Update the game over message`. | ||
| 7. Enter a description for your pull request: `Update the game over message so people know how to play again!` | ||
| 8. Click **Create pull request**. | ||
| 9. 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. | ||
| 1. Open this repository in a new browser tab so you can work on the steps while you read the instructions in this tab. | ||
|
|
||
| 1. In the top navigation, select the **Pull requests** tab. | ||
|
|
||
| 1. On the right, click the **New pull request** button. | ||
|
|
||
| 1. Under the **Compare changes** area, select the following options and click the **Create pull request** button. | ||
|
|
||
| - **base:** `main` | ||
| - **compare:** `update-game` | ||
|
|
||
| 1. Set the **title** and **description** to the following. | ||
|
|
||
| ```md | ||
| Update game over message | ||
| ``` | ||
|
|
||
| ```md | ||
| Update the game over message so people know how to play again! | ||
| ``` | ||
|
|
||
| 1. Click **Create pull request**. | ||
|
|
||
| 1. With the pull request created, Mona will check your progress and share the next steps. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,16 @@ | ||
| <!-- | ||
| <<< Author notes: Step 2 >>> | ||
| Start this step by acknowledging the previous step. | ||
| Define terms and link to docs.github.com. | ||
| Historic note: this step combines the commend, approve, and needs changes steps from the previous version. | ||
| --> | ||
|
|
||
| ## Step 2: Assign yourself | ||
|
|
||
| _Great job opening that pull request! :wave:_ | ||
|
|
||
| **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. | ||
| #### What is an assignee? | ||
|
|
||
| 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. | ||
| A **pull request assignee** is the person (or persons) most familiar with the the proposed changes. | ||
| It's a simple mechanism for keeping track of who to contact for questions. | ||
|
|
||
| ### :keyboard: Activity: Assign yourself | ||
|
|
||
| 1. Open the pull request you just created. | ||
| 1. Under **Assignees** on the right side of the screen, add yourself. | ||
| 1. If not on the created pull request, navigate back to it. | ||
|
|
||
| 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: | ||
| 1. On the right side, under **Assignees**, click the **assign yourself** text. | ||
|
|
||
| 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. | ||
| 1. After assigning yourself, Mona will check your progress and share the next steps. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,44 @@ | ||
| <!-- | ||
| <<< Author notes: Step 4 >>> | ||
| Start this step by acknowledging the previous step. | ||
| Define terms and link to docs.github.com. | ||
| --> | ||
|
|
||
| ## Step 4: Suggest changes | ||
|
|
||
| _Nice work reviewing that pull request :sparkles:_ | ||
|
|
||
| Now that you have explored the different ways you can review a pull request it is time to learn how to use _suggest changes_. | ||
| 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. | ||
|
|
||
| ### How do I suggest a change? | ||
|
|
||
| **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. | ||
| 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! | ||
|
|
||
| ### :keyboard: Activity: Suggest changes | ||
|
|
||
| 1. On the pull request, click **Files changed**. | ||
| 1. Find the `index.html` changes. | ||
| 1. Hover your cursor next to the line numbers on the left side of the page. | ||
| 1. Click the blue plus icon. | ||
| 1. After the comment form appears, click the **Add a suggestion** button. <br> | ||
|  | ||
| 1. Edit the suggestion. | ||
| 1. Click **Add a single comment**. | ||
| 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. | ||
|
|
||
| 1. Find the comparison view for the `index.html` file. | ||
|
|
||
| 1. Hover your cursor next to the line numbers for the modified line. | ||
|
|
||
| 1. Click the plus icon to show an inline comment form. | ||
|
|
||
| 1. Click the **Add a suggestion** button to insert a modifiable copy of the line. | ||
|
|
||
| <img width="300" alt="add-a-suggestion-button" src="https://github.com/user-attachments/assets/dc781d29-d5fe-4da9-9e4b-eb406c5d9ab5" /> | ||
|
|
||
| 1. Edit the suggestion to match below and click the **Add a single comment** button. | ||
|
|
||
| ````md | ||
| ```suggestion | ||
| <h2 hidden>Game over! Want to play again?! Just click refresh. 🧑🚀!</h2> | ||
| ``` | ||
| Let's make it a bit more friendly. 🤓 | ||
| ```` | ||
|
|
||
| ### :keyboard: Activity: Apply a suggested change | ||
|
|
||
| 1. Click the **Commit suggestion** button to open a commit message form. | ||
|
|
||
| 1. Edit the commit message to the below text and click the **Commit changes** button. | ||
|
|
||
| ```markdown | ||
| Make the end game experience more friendly | ||
| ``` | ||
|
|
||
| 1. With the changes committed, Mona will check your progress then prepare and share the next steps. |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| ## Step 6: Merge your pull request | ||
|
|
||
| _Almost done!_ :heart: | ||
|
|
||
| With our reviews collected and feedback implemented, it's time to merge the changes. | ||
|
|
||
| ### :keyboard: Activity: Merge your pull request | ||
|
|
||
| 1. In the pull request navigation, select the **Conversation** tab. | ||
|
|
||
| 1. Scroll down and click the **Merge pull request** button. | ||
|
|
||
| 1. (optional) Delete the `update-game` branch. | ||
|
|
||
| 1. With the pull request merged, Mona will check your progress and prepare a final review. Congrats you are done! 🎉 | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.