diff --git a/.github/steps/2-commit-a-file.md b/.github/steps/2-commit-a-file.md index 0c3a1ea16..919102c39 100644 --- a/.github/steps/2-commit-a-file.md +++ b/.github/steps/2-commit-a-file.md @@ -16,6 +16,9 @@ Creating a branch allows you to edit your project without changing the `main` br 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. +> [!NOTE] +> `.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. + 1. On the **< > Code** tab in the header menu of your repository, make sure you're on your new branch `my-first-branch`. 2. Select the **Add file** drop-down and click **Create new file**. @@ -24,19 +27,17 @@ The following steps will guide you through the process of committing a change on 3. In the **Name your file...** field, enter `PROFILE.md`. - **Note:** `.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. - 4. In the **Enter file contents here** area, copy the following content to your file: ``` Welcome to my GitHub profile! ``` - profile.md file screenshot + ![profile.md file screenshot](/images/my-profile-file.png) 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". - screenshot of adding a new file with a commit message + ![screenshot of adding a new file with a commit message](/images/commit-full-screen.png) 6. In this lesson, we'll ignore the other fields and click **Commit changes**. 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. diff --git a/.github/steps/3-open-a-pull-request.md b/.github/steps/3-open-a-pull-request.md index 6de9a0f13..ed9cba0b6 100644 --- a/.github/steps/3-open-a-pull-request.md +++ b/.github/steps/3-open-a-pull-request.md @@ -27,17 +27,18 @@ To create a pull request automatically, click **Compare & pull request**, and th 3. In the **base:** dropdown, make sure **main** is selected. 4. Select the **compare:** dropdown, and click `my-first-branch`. - screenshot showing both branch selections + ![screenshot showing both branch selections](/images/pull-request-branches.png) 5. Click **Create pull request**. 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`. 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. - screenshot showing pull request + ![screenshot showing pull request](/images/Pull-request-description.png) 8. Click **Create pull request**. You will automatically be navigated to your new 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. - **Note**: 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. - - screenshot of an example of an actions line +> [!NOTE] +> 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. +> +> ![screenshot of an example of an actions line](/images/Actions-to-step-4.png) diff --git a/.github/steps/4-merge-your-pull-request.md b/.github/steps/4-merge-your-pull-request.md index b0bf8bff0..6b26b90a7 100644 --- a/.github/steps/4-merge-your-pull-request.md +++ b/.github/steps/4-merge-your-pull-request.md @@ -23,8 +23,9 @@ As noted in the previous step, you may have seen evidence of GitHub Actions runn 2. Click **Confirm merge**. 3. Once your branch has been merged, you don't need it anymore. To delete this branch, click **Delete branch**. - screenshot showing delete branch button + ![screenshot showing delete branch button](/images/delete-branch.png) 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. - **Note**: Check out the **Finish** step to see what you can learn next! +> [!NOTE] +> Check out the **Finish** step to see what you can learn next! diff --git a/README.md b/README.md index 7de2d974b..79ea84fca 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,6 @@ In this course, you will: Get help: [Post in our discussion board](https://github.com/orgs/skills/discussions/categories/introduction-to-github) • [Review the GitHub status page](https://www.githubstatus.com/) -© 2023 GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit) +© 2024 GitHub • [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) • [MIT License](https://gh.io/mit) diff --git a/images/my-profile-file.png b/images/my-profile-file.png index 84c97a6b2..ae7ffd68b 100644 Binary files a/images/my-profile-file.png and b/images/my-profile-file.png differ