Skip to content

Commit 982ce10

Browse files
feat: Refactor to issue-based flow (#1593)
Co-authored-by: FidelusAleksander <[email protected]>
1 parent 0e8980e commit 982ce10

29 files changed

+619
-380
lines changed

.github/dependabot.yml

-6
This file was deleted.

.github/steps/-step.txt

-1
This file was deleted.

.github/steps/0-welcome.md

-1
This file was deleted.

.github/steps/1-create-a-branch.md

+40-24
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,61 @@
1-
<!--
2-
<<< Author notes: Step 1 >>>
3-
Choose 3-5 steps for your course.
4-
The first step is always the hardest, so pick something easy!
5-
Link to docs.github.com for further explanations.
6-
Encourage users to open new tabs for steps!
7-
-->
8-
91
## Step 1: Create a branch
102

113
_Welcome to "Introduction to GitHub"! :wave:_
124

13-
**What is GitHub?**: GitHub is a collaboration platform that uses _[Git](https://docs.github.com/get-started/quickstart/github-glossary#git)_ for versioning. GitHub is a popular place to share and contribute to [open-source](https://docs.github.com/get-started/quickstart/github-glossary#open-source) software.
14-
<br>:tv: [Video: What is GitHub?](https://www.youtube.com/watch?v=pBy1zgt0XPc)
5+
**What is GitHub?**: GitHub is a collaboration platform that uses _[Git](https://docs.github.com/get-started/quickstart/github-glossary#git)_ for versioning.
6+
GitHub is a popular place to share and contribute to [open-source](https://docs.github.com/get-started/quickstart/github-glossary#open-source) software.
7+
8+
:tv: [Video: What is GitHub?](https://www.youtube.com/watch?v=pBy1zgt0XPc)
159

16-
**What is a repository?**: A _[repository](https://docs.github.com/get-started/quickstart/github-glossary#repository)_ is a project containing files and folders. A repository tracks versions of files and folders. For more information, see "[About repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories)" from GitHub Docs.
10+
**What is a repository?**: A _[repository](https://docs.github.com/get-started/quickstart/github-glossary#repository)_ is a project containing files and folders.
11+
A repository tracks versions of files and folders. For more information, see
12+
"[About repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories)" from GitHub Docs.
1713

18-
**What is a branch?**: A _[branch](https://docs.github.com/en/get-started/quickstart/github-glossary#branch)_ is a parallel version of your repository. By default, your repository has one branch named `main` and it is considered to be the definitive branch. Creating additional branches allows you to copy the `main` branch of your repository and safely make any changes without disrupting the main project. Many people use branches to work on specific features without affecting any other parts of the project.
14+
**What is a branch?**: A _[branch](https://docs.github.com/en/get-started/quickstart/github-glossary#branch)_ is a parallel version of your repository.
15+
By default, your repository has one branch named `main` and it is considered to be the definitive branch.
16+
Creating additional branches allows you to copy the `main` branch of your repository and safely make any changes without disrupting the main project.
17+
Many people use branches to work on specific features without affecting any other parts of the project.
1918

20-
Branches allow you to separate your work from the `main` branch. In other words, everyone's work is safe while you contribute. For more information, see "[About branches](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)".
19+
Branches allow you to separate your work from the `main` branch.
20+
In other words, everyone's work is safe while you contribute.
21+
For more information, see "[About branches](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches)".
2122

22-
**What is a profile README?**: A _[profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)_ is essentially an "About me" section on your GitHub profile where you can share information about yourself with the community on GitHub.com. GitHub shows your profile README at the top of your profile page. For more information, see "[Managing your profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)".
23+
**What is a profile README?**: A _[profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)_
24+
is essentially an "About me" section on your GitHub profile where you can share information about yourself with the community on GitHub.com.
25+
GitHub shows your profile README at the top of your profile page. For more information, see "[Managing your profile README](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme)".
2326

24-
![profile-readme-example](/images/profile-readme-example.png)
27+
![screenshot showing an example profile readme](https://github.com/user-attachments/assets/9425d1aa-04ba-459b-b89d-31fbae87c743)
2528

2629
### :keyboard: Activity: Your first branch
2730

28-
1. Open a new browser tab and navigate to your newly made repository. Then, work on the steps in your second tab while you read the instructions in this tab.
31+
1. Open a new browser tab and navigate to your newly made repository (your copy of this exercise). Then, work on the steps in your second tab while you read the instructions in this tab.
32+
2933
2. Navigate to the **< > Code** tab in the header menu of your repository.
3034

31-
![code-tab](/images/code-tab.png)
35+
![screenshot highlighting the code tab](https://github.com/user-attachments/assets/8e1283ea-9cea-4a7e-8359-a7617734ff9a)
3236

3337
3. Click on the **main** branch drop-down.
3438

35-
![main-branch-dropdown](/images/main-branch-dropdown.png)
39+
<img width="300" alt="screenshot highlighting the branch selection" src="https://github.com/user-attachments/assets/1a07c958-cebf-4ca5-805e-22c1725635ba">
40+
41+
4. In the text box **Find or create a branch...**, enter `my-first-branch`.
42+
43+
> **Note:** This is checked to continue with the next step. :wink:
44+
45+
5. Click the text **Create branch: `my-first-branch` from main** to create your branch.
46+
47+
<img width="300" alt="screenshot highlighting the create branch prompt" src="https://github.com/user-attachments/assets/99d19ff5-4482-4210-ae45-84e7b7c47632">
48+
49+
- The branch will automatically switch to the one you just created.
50+
- The **main** branch drop-down menu will display your new branch name.
51+
52+
6. Now that your branch is pushed to GitHub, Mona should already be busy checking your work. Give her a moment and keep watch in the comments. You will see her respond with progress info and the next lesson.
3653

37-
4. In the field, name your branch `my-first-branch`. In this case, the name must be `my-first-branch` to trigger the course workflow.
38-
5. Click **Create branch: my-first-branch** to create your branch.
3954

40-
![create-branch-button](/images/create-branch-button.png)
55+
<details>
56+
<summary>Having trouble? 🤷</summary><br/>
4157

42-
The branch will automatically switch to the one you have just created.
43-
The **main** branch drop-down bar will reflect your new branch and display the new branch name.
58+
If you don't get feedback, here are some things to check:
59+
- Make sure your created the branch with the exact name `my-first-branch`. No prefixes or suffixes.
4460

45-
6. 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.
61+
</details>

.github/steps/2-commit-a-file.md

+23-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
<!--
2-
<<< Author notes: Step 2 >>>
3-
Start this step by acknowledging the previous step.
4-
Define terms and link to docs.github.com.
5-
-->
6-
71
## Step 2: Commit a file
82

93
_You created a branch! :tada:_
@@ -14,16 +8,16 @@ Creating a branch allows you to edit your project without changing the `main` br
148

159
### :keyboard: Activity: Your first commit
1610

17-
The following steps will guide you through the process of committing a change on GitHub. A commit records changes in renaming, changing content within, creating a new file, and any other changes made to your project. For this exercise, committing a change requires first adding a new file to your new branch.
11+
The following steps will guide you through the process of committing a change on GitHub. A commit records changes to the project such as adding/removing/renaming files and modifying file content. For this exercise, committing a change will be adding a new file to your new branch.
1812

1913
> [!NOTE]
20-
> `.md` is a file extension that creates a Markdown file. You can learn more about Markdown by visiting "[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" in our docs or by taking the "[Communicating using Markdown](https://github.com/skills/communicate-using-markdown)" Skills course.
14+
> `.md` is a file extension that creates a Markdown file. You can learn more about Markdown by visiting "[Basic writing and formatting syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)" in our docs or by taking the "[Communicating using Markdown](https://github.com/skills/communicate-using-markdown)" Skills Exercise.
2115
2216
1. On the **< > Code** tab in the header menu of your repository, make sure you're on your new branch `my-first-branch`.
2317

2418
2. Select the **Add file** drop-down and click **Create new file**.
2519

26-
![create new file option](/images/create-new-file.png)
20+
<img width="300" alt="screenshot of the create new file option" src="https://github.com/user-attachments/assets/cfb062cd-be60-4f12-948c-0946a6fe01da">
2721

2822
3. In the **Name your file...** field, enter `PROFILE.md`.
2923

@@ -33,11 +27,26 @@ The following steps will guide you through the process of committing a change on
3327
Welcome to my GitHub profile!
3428
```
3529

36-
![profile.md file screenshot](/images/my-profile-file.png)
30+
![screenshot for adding the profile.md file](https://github.com/user-attachments/assets/e00540be-4334-4d0d-adc2-9893b5477a91)
31+
32+
5. Click **Commit changes...** in the upper right corner above the contents box. A dialog will appear.
33+
34+
6. GitHub offers a simple default message, but let's change it slightly for practice. Enter `Add PROFILE.md` in the **Commit message** field.
35+
36+
- A **commit message** and optional **extended description** help provide clarity for your changes. This is particularly useful when your commit involves several files.
37+
38+
<img width="400" alt="screenshot of adding a new file with a commit message" src="https://github.com/user-attachments/assets/6ab299ce-8039-4734-a707-d7c3cd7077a0">
39+
40+
6. In this lesson, we'll ignore the other fields for now and click **Commit changes**.
41+
42+
7. Now that you've changed a file, Mona should already be busy checking your work. Give her a moment and keep watch in the comments. You will see her respond with progress info and the next lesson.
43+
3744

38-
5. Click **Commit changes...** in the upper right corner above the contents box. For commits, you can enter a short commit message that describes what changes you made. This message helps others know what's included in your commit. GitHub offers a simple default message, but let's change it slightly for practice. First, enter `Add PROFILE.md` in the first text-entry field titled "Commit message".
45+
<details>
46+
<summary>Having trouble? 🤷</summary><br/>
3947

40-
![screenshot of adding a new file with a commit message](/images/commit-full-screen.png)
48+
If you don't get feedback, here are some things to check:
49+
- Make sure you are on the `my-first-branch` branch.
50+
- Ensure the `PROFILE.md` file is created and in the root folder.
4151

42-
6. In this lesson, we'll ignore the other fields and click **Commit changes**.
43-
7. 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.
52+
</details>
+27-25
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
<!--
2-
<<< Author notes: Step 3 >>>
3-
Just a historic note: the previous version of this step forced the learner
4-
to write a pull request description,
5-
checked that `main` was the receiving branch,
6-
and that the file was named correctly.
7-
-->
8-
91
## Step 3: Open a pull request
102

113
_Nice work making that commit! :sparkles:_
@@ -18,27 +10,37 @@ Now that you have made a change to the project and created a commit, it’s time
1810

1911
You may have noticed after your commit that a message displayed indicating your recent push to your branch and providing a button that says **Compare & pull request**.
2012

21-
![screenshot of message and button](/images/compare-and-pull-request.png)
13+
![screenshot of message and button](https://github.com/user-attachments/assets/47b82c6e-d45b-4854-b8b4-1cb2c33af05f)
14+
15+
To create a pull request automatically, click **Compare & pull request** button, and then skip to step 5 below. Alternately, you practice creating it manually using the first 4 steps.
16+
17+
1. In the header menu of your repository, click the **Pull requests** tab .
18+
2. Click the **New pull request** button.
19+
3. Select the following branches using the dropdown menus.
20+
21+
- **base:** `main`
22+
- **compare:** `my-first-branch`
23+
24+
![screenshot showing both branch selections](https://github.com/user-attachments/assets/140ca348-b6de-4c3c-b29f-fd57944d98a9)
25+
26+
4. Click **Create pull request**.
27+
28+
5. Enter a title for your pull request. By default, the title will automatically be the name of your branch. For this exercise, let's edit the field to say `Add my first file`.
29+
30+
6. The next field helps you provide a **description** of the changes you made. Please enter a short description of what you’ve accomplished so far. As a reminder, you have: created a new branch, created a file, and made a commit.
2231

23-
To create a pull request automatically, click **Compare & pull request**, and then skip to step 6 below. If you don't click the button, the instructions below walk you through manually setting up the pull request.
32+
![screenshot showing pull request](https://github.com/user-attachments/assets/e03171f9-98cc-4067-a473-78424618f1f8)
2433

25-
1. Click on the **Pull requests** tab in the header menu of your repository.
26-
2. Click **New pull request**.
27-
3. In the **base:** dropdown, make sure **main** is selected.
28-
4. Select the **compare:** dropdown, and click `my-first-branch`.
34+
7. Click **Create pull request**.
2935

30-
![screenshot showing both branch selections](/images/pull-request-branches.png)
36+
8. Now that you've started a place to collaborate, Mona should already be busy checking your work. Give her a moment and keep watch in the comments. You will see her respond with progress info and the next lesson.
3137

32-
5. Click **Create pull request**.
33-
6. Enter a title for your pull request. By default, the title will automatically be the name of your branch. For this exercise, let's edit the field to say `Add my first file`.
34-
7. The next field helps you provide a description of the changes you made. Here, you can add a description of what you’ve accomplished so far. As a reminder, you have: created a new branch, created a file, and made a commit.
3538

36-
![screenshot showing pull request](/images/Pull-request-description.png)
39+
<details>
40+
<summary>Having trouble? 🤷</summary><br/>
3741

38-
8. Click **Create pull request**. You will automatically be navigated to your new pull request.
39-
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.
42+
If you don't get feedback, here are some things to check:
43+
- Make sure your pull request title is correct.
44+
- Ensure your pull request has a description.
4045

41-
> [!NOTE]
42-
> You may see evidence of GitHub Actions running on the tab with the pull request opened! The image below shows a line you might see on your pull request after the Action finishes running.
43-
>
44-
> ![screenshot of an example of an actions line](/images/Actions-to-step-4.png)
46+
</details>
+17-15
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
1-
<!--
2-
<<< Author notes: Step 4 >>>
3-
Just a historic note: The previous version of this step required responding
4-
to a pull request review before merging. The previous version also handled
5-
if users accidentally closed without merging.
6-
-->
7-
81
## Step 4: Merge your pull request
92

103
_Nicely done! :sunglasses:_
114

12-
You successfully created a pull request. You can now merge your pull request.
5+
You successfully created a pull request. Now it's time merge it!
136

147
**What is a merge?**: A _[merge](https://docs.github.com/en/get-started/quickstart/github-glossary#merge)_ adds the changes in your pull request and branch into the `main` branch. For more information about merges, see "[Merging a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request)."
158

16-
As noted in the previous step, you may have seen evidence of GitHub Actions running which automatically progresses your instructions to the next step. You'll have to wait for it to finish before you can merge your pull request. It will be ready when the merge pull request button is green.
17-
18-
![screenshot of green merge pull request button](/images/Green-merge-pull-request.png)
9+
![screenshot of green merge pull request button](https://github.com/user-attachments/assets/ce2f04cb-8a71-411f-8dc8-827a2bc23a30)
1910

2011
### :keyboard: Activity: Merge the pull request
2112

2213
1. Click **Merge pull request**.
14+
15+
> **Note:** You may see workflows running on your new pull request, causing the merge button to be inactive. Just wait a moment for them to finish and the merge button will activate.
16+
2317
2. Click **Confirm merge**.
18+
19+
> **Tip:** Did you notice this dialog looks similar to adding a file? A merge is also a kind of commit!
20+
2421
3. Once your branch has been merged, you don't need it anymore. To delete this branch, click **Delete branch**.
2522

26-
![screenshot showing delete branch button](/images/delete-branch.png)
23+
![screenshot showing delete branch button](https://github.com/user-attachments/assets/0fda948e-14e0-4643-aa53-d9f9f364cddd)
24+
25+
4. Now that your work is merged, Mona will confirm and share some final review content. Nice work! 🎉
26+
27+
<details>
28+
<summary>Having trouble? 🤷</summary><br/>
2729

28-
4. 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.
30+
If you don't get feedback, here are some things to check:
31+
- Make sure you completed the previous lessons. If they haven't passed, the merge button will be gray.
2932

30-
> [!NOTE]
31-
> Check out the **Finish** step to see what you can learn next!
33+
</details>

0 commit comments

Comments
 (0)