From ec4ee01eca1519eb94ad21c3bc5195b478770f4e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 11 Oct 2024 19:42:49 +0000 Subject: [PATCH] Update to 2 in STEP and README.md --- .github/steps/-step.txt | 2 +- README.md | 50 ++++++++++++++++++++--------------------- 2 files changed, 25 insertions(+), 27 deletions(-) diff --git a/.github/steps/-step.txt b/.github/steps/-step.txt index d00491f..0cfbf08 100644 --- a/.github/steps/-step.txt +++ b/.github/steps/-step.txt @@ -1 +1 @@ -1 +2 diff --git a/README.md b/README.md index f3029e6..17b21d6 100644 --- a/README.md +++ b/README.md @@ -14,50 +14,48 @@ _Get started using GitHub in less than an hour._ -## Step 1: Create a branch +## Step 2: Commit a file -_Welcome to "Introduction to GitHub"! :wave:_ +_You created a branch! :tada:_ -**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. -
:tv: [Video: What is GitHub?](https://www.youtube.com/watch?v=pBy1zgt0XPc) +Creating a branch allows you to edit your project without changing the `main` branch. Now that you have a branch, it’s time to create a file and make your first commit! -**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. +**What is a commit?**: A _[commit](https://docs.github.com/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)_ is a set of changes to the files and folders in your project. A commit exists in a branch. For more information, see "[About commits](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits)". -**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. +### :keyboard: Activity: Your first commit -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)". +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. -**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)". +> [!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. -![profile-readme-example](/images/profile-readme-example.png) +1. On the **< > Code** tab in the header menu of your repository, make sure you're on your new branch `my-first-branch`. -### :keyboard: Activity: Your first branch +2. Select the **Add file** drop-down and click **Create new file**. -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. -2. Navigate to the **< > Code** tab in the header menu of your repository. + ![create new file option](/images/create-new-file.png) - ![code-tab](/images/code-tab.png) +3. In the **Name your file...** field, enter `PROFILE.md`. -3. Click on the **main** branch drop-down. +4. In the **Enter file contents here** area, copy the following content to your file: - ![main-branch-dropdown](/images/main-branch-dropdown.png) + ``` + Welcome to my GitHub profile! + ``` -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. -5. Click **Create branch: my-first-branch** to create your branch. + ![profile.md file screenshot](/images/my-profile-file.png) - ![create-branch-button](/images/create-branch-button.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". - The branch will automatically switch to the one you have just created. - The **main** branch drop-down bar will reflect your new branch and display the new branch name. + ![screenshot of adding a new file with a commit message](/images/commit-full-screen.png) -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. +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.