Updating course from feedback (skills#7)

* Updating course from feedback. * Update README.md * updating image tags * Update README.md * replaced image to match text * fixed link Co-authored-by: Kevin Heis <[email protected]>
asdk24 · Jun 4, 2022 · cdbc8c5 · cdbc8c5
1 parent b672f72
commit cdbc8c5
Show file tree

Hide file tree

Showing 11 changed files with 67 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -59,17 +59,23 @@ _Welcome to "Introduction to GitHub"! :wave:_
 **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.
 <br>:tv: [Video: Exploring a repository](https://www.youtube.com/watch?v=R8OAwrcMlRw)
 
-**What is a branch?**: A [branch](https://docs.github.com/en/get-started/quickstart/github-glossary#branch) is a parallel version of your repository. You can make edits in your branch without impacting the `main` version. Branches allow us to separate our work from the `main` branch. In other words, everyone's work is safe while you contribute.
+**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. You can create additional branches off of `main` in your repository. You can use branches to have different versions of a project at one time.
+
+On additional branches, you can make edits without impacting the `main` version. Branches allow you to separate your work from the `main` branch. In other words, everyone's work is safe while you contribute.
 <br>:tv: [Video: Branches](https://www.youtube.com/watch?v=xgQmu81G1yY)
 
+**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.
+
 ### :keyboard: Activity: Your first branch
 
-1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab.
-1. Navigate to the **Code** tab.
-1. Click **Branch: main** in the drop-down.
-1. In the field, enter a name for your branch: `my-first-branch`.
-1. Click **Create branch: my-first-branch** or press the <kbd>Enter</kbd> key to create your branch.
-1. Wait about 20 seconds then refresh this page for the next step.
+1. Open a new browser tab, and navigate to this same repository. Then, work on the steps in your second tab while you read the instructions in this tab.
+2. Navigate to the **Code** tab.
+3. Click on the **main** branch drop-down.<br>
+   <img alt="image showing my-first-branch entry" src="/images/my-first-branch.png"/>
+4. In the field, enter a name for your branch: `my-first-branch`.
+5. Click **Create branch: my-first-branch** to create your branch.
+6. Move on to Step 2!<br>
+   **Note**: If you made a public repository, and want to confirm you correctly set up your first branch, 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 close this step and open the next one.
 
 </details>
 
@@ -90,20 +96,25 @@ Creating a branch allows you to edit to your project without changing the `main`
 
 ### :keyboard: Activity: Your first commit
 
-The following steps will guide you through the process of committing a change on GitHub.
+The following steps will guide you through the process of committing a change on GitHub. Committing a change requires first adding a new file to your new branch. 
 
-1. Create a new file on this branch called `PROFILE.md`.
-   - Make sure you are on the "Code" tab.
-   - In the branch drop-down, select `my-first-branch`.
-   - Click **Create new file**.
-   - In the "file name" field, type `PROFILE.md`.
-1. When you’re done naming the file, add the following content to your file:
-   ```md
+1. On the **Code** tab, make sure you're on your new branch `my-first-branch`.
+2. Select the **Add file** drop-down and click **Create new file**.<br>
+   ![create new file option](/images/create-new-file.png)
+3. In the **Name your file...** field, enter `PROFILE.md`.
+4. In the **Edit new file** area, copy the following content to your file:
+   ```
    Welcome to my GitHub profile!
    ```
-1. After adding the text, you can commit the change by entering a brief commit message `Add PROFILE.md` in the text-entry field below the file edit view.
-1. After you’ve entered a commit message, click **Commit new file**.
-1. Wait about 20 seconds then refresh this page for the next step.
+   <img alt="profile.md file screenshot" src="/images/my-profile-file.png"/>
+5. For commits, you can enter a short commit message that describes what you changes you made. This helps others know what's included in your commit. GitHub offers a simple default message, but let's change it slightly for practice. Enter `Adding PROFILE.md` in the first text-entry field below **Commit new file**. Then, if you want to confirm what your screen should look like, expand the dropdown below.
+   <details>
+   <summary> Expand to see the screenshot.</summary>
+   <img alt="screenshot of adding a new file with a commit message" src="/images/commit-full-screen.png" />
+   </details>
+6. In this lesson, we'll ignore the other fields and click **Commit new file**.
+7. Move on to Step 3! <br>
+   **Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one.
 
 </details>
 
@@ -127,14 +138,25 @@ Now that you’ve created a commit, it’s time to share your proposed change th
 
 ### :keyboard: Activity: Create a pull request
 
-1. Open a pull request:
-   - From the "Pull requests" tab, click **New pull request**.
-   - In the "base:" drop-down menu, make sure the "main" branch is selected.
-   - In the "compare:" drop-down menu, select `my-first-branch`.
-1. When you’ve selected your branch, enter a title for your pull request: `Add my first file`.
-1. The next field helps you provide a description of the changes you made. Feel free to add a description of what you’ve accomplished so far. As a reminder, you have: created a branch, created a file and made a commit, and opened a pull request.
-1. Click **Create pull request**.
-1. Wait about 20 seconds then refresh this page for the next step.
+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**.
+
+![screenshot of message and button](/images/compare-and-pull-request.png)
+
+ If you want, feel free to 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.
+
+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 `my-first-branch`. <br>
+   <img alt="screenshot showing both branch selections" src="/images/pull-request-branches.png"/>
+5. Click **Create pull request**.
+6. Enter a title for your pull request: `Add my first file`.
+7. The next field helps you provide a description of the changes you made. Feel free to add a description of what you’ve accomplished so far. As a reminder, you have: created a branch, created a file and made a commit! <br>
+   <img alt="screenshot showing pull request" src="/images/Pull-request-description.png"/>
+8. Click **Create pull request**.
+9. Move on to Step 4! <br>
+   **Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one. As a perk, 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.<br>
+   <img alt="screenshot of an example of an actions line" src="/images/Actions-to-step-4.png"/>
 
 </details>
 
@@ -155,12 +177,17 @@ You successfully created a pull request. You can now merge your pull request.
 **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.
 <br>:tv: [Video: Understanding the GitHub flow](https://www.youtube.com/watch?v=PBI2Rz-ZOxU)
 
+As noted in the previous step, you may have seen evidence of an action 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.
+
+![screenshot of green merge pull request button](/images/Green-merge-pull-request.png)
 ### :keyboard: Activity: Merge the pull request
 
 1. Click **Merge pull request**.
 1. Click **Confirm merge**.
-1. Once your branch has been merged, you don't need it anymore and you may click **Delete branch**.
-1. Wait about 20 seconds then refresh this page for the next step.
+1. Once your branch has been merged, you don't need it anymore. To delete this branch, click **Delete branch**.<br>
+   <img alt="screenshot showing delete branch button" src="/images/delete-branch.png"/>
+2. Check out the **Finish** step to see what you can learn next!<br>
+   **Note**: Like before, you can wait about 20 seconds, then refresh this page (the one you're following instructions from) and [GitHub Actions](https://docs.github.com/en/actions) will automatically close this step and open the next one.
 
 </details>
 
@@ -172,11 +199,11 @@ You successfully created a pull request. You can now merge your pull request.
 <details id=X>
 <summary><h2>Finish</h2></summary>
 
-_Congratulations friend, you've completed this course!_
+_Congratulations friend, you've completed this course and joined the world of developers!_
 
 <img src=https://octodex.github.com/images/collabocats.jpg alt=celebrate width=300 align=right>
 
-Here's a recap of all the tasks you've accomplished in your repository:
+Here's a recap of your accomplishments:
 
 - You learned about GitHub, repositories, branches, commits, and pull requests.
 - You created a branch, a commit, and a pull request.
@@ -185,12 +212,16 @@ Here's a recap of all the tasks you've accomplished in your repository:
 
 ### What's next?
 
-- If you'd like the contents of your `PROFILE.md` file to be on your GitHub profile:
-  - Make a new branch.
-  - Edit the contents into this `README.md` file.
-  - Delete `PROFILE.md` on your branch.
-  - Open and merge a pull request using your branch.
-- We'd love to hear what you thought of this course [in our discussion board](https://github.com/skills/.github/discussions).
+  If you'd like to make a profile README, use the simplified instructions below or follow the instructions in the [Managing your profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme) article.
+  1. Make a new public repository with a name that matches your GitHub username.
+  2. Create a file named `README.md` in it's root. The "root" means not inside any folder in your repository.
+  3. Edit the contents of the `README.md` file.
+  4. If you created a new branch for your file, open and merge a pull request on your branch.
+  5. We'd love to see your new profile! Share your profile on social media and tag us!
+  6. Lastly, we'd love to hear what you thought of this course [in our discussion board](https://github.com/skills/.github/discussions).
+
+Check out these resources to learn more or get involved:
+- Are you a student? Check out the [Student Developer Pack](https://education.github.com/pack).
 - [Take another GitHub Skills course](https://github.com/skills).
 - [Read the GitHub Getting Started docs](https://docs.github.com/en/get-started).
 - To find projects to contribute to, check out [GitHub Explore](https://github.com/explore).

diff --git a/images/Actions-to-step-4.png b/images/Actions-to-step-4.png
diff --git a/images/Green-merge-pull-request.png b/images/Green-merge-pull-request.png
diff --git a/images/Pull-request-description.png b/images/Pull-request-description.png
diff --git a/images/commit-full-screen.png b/images/commit-full-screen.png
diff --git a/images/compare-and-pull-request.png b/images/compare-and-pull-request.png
diff --git a/images/create-new-file.png b/images/create-new-file.png
diff --git a/images/delete-branch.png b/images/delete-branch.png
diff --git a/images/my-first-branch.png b/images/my-first-branch.png
diff --git a/images/my-profile-file.png b/images/my-profile-file.png
diff --git a/images/pull-request-branches.png b/images/pull-request-branches.png