Skip to content

Rewrite README for clarity and improved user onboarding #1763

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 78 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,51 +1,95 @@
# Introduction to GitHub
# 🌟 Introduction to GitHub

_Get started using GitHub in less than an hour._
_Get started with GitHub in under an hour — no experience needed!_

## Welcome
---

## 👋 Welcome

GitHub is where people build some of the most advanced technologies in the world — from data visualization dashboards to video games. Whether you're just starting out or exploring open source, there's a community and a set of tools here to help you succeed.

**This exercise, _"Introduction to GitHub,"_ walks you through the basics and gets you ready to collaborate — in less than an hour.**

---

## 🧠 What You'll Learn

- ✅ What GitHub is and why developers use it
- ✅ How to work with repositories, branches, commits, and pull requests
- ✅ How to build and share your own Markdown file (ideal for your [profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme))

---

## 👤 Who Is This For?

- 🚀 New developers
- 🧑‍🎓 Students
- 🆕 Anyone new to Git or GitHub

**No prerequisites! Just curiosity and a GitHub account.**

---

## 🧱 What You'll Do

By the end of this exercise, you will:

1. Create a new branch
2. Make a commit
3. Open a pull request
4. Merge your pull request

All of this happens in a guided, interactive format. No setup required.

---

People use GitHub to build some of the most advanced technologies in the world. Whether you’re visualizing data or building a new game, there’s a whole community and set of tools on GitHub that can help you do it even better. GitHub Skills’ “Introduction to GitHub” exercise guides you through everything you need to start contributing in less than an hour.
## ▶️ How to Start the Exercise

- **Who is this for**: New developers, new GitHub users, and students.
- **What you'll learn**: We'll introduce repositories, branches, commits, and pull requests.
- **What you'll build**: We'll make a short Markdown file you can use as your [profile README](https://docs.github.com/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme).
- **Prerequisites**: None. This exercise is a great introduction for your first day on GitHub.
- **How long**: This exercise takes less than one hour to complete.
Follow these quick steps:

In this exercise, you will:
### 1. Copy the Exercise Template

1. Create a branch
2. Commit a file
3. Open a pull request
4. Merge your pull request
Right-click the button below and open the link in a new tab:

### How to start this exercise
<a id="copy-exercise" href="https://github.com/new?template_owner=skills&template_name=introduction-to-github&owner=%40me&name=skills-introduction-to-github&description=Exercise:+Introduction+to+GitHub&visibility=public">
<img src="https://img.shields.io/badge/📠_Copy_Exercise-008000" height="25pt"/>
</a>

1. Right-click **Copy Exercise** and open the link in a new tab.
In the new tab:

<a id="copy-exercise" href="https://github.com/new?template_owner=skills&template_name=introduction-to-github&owner=%40me&name=skills-introduction-to-github&description=Exercise:+Introduction+to+GitHub&visibility=public">
<img src="https://img.shields.io/badge/📠_Copy_Exercise-008000" height="25pt"/>
</a>
- Choose your personal account or organization as the **owner**.
- Set the visibility to **public** (recommended).
- Scroll down and click **Create repository**.

2. In the new tab, most of the prompts will automatically fill in for you.
- For owner, choose your personal account or an organization to host the repository.
- We recommend creating a public repository, as private repositories will [use Actions minutes](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions).
- Scroll down and click the **Create repository** button at the bottom of the form.
### 2. Wait for Setup

3. After your new repository is created, wait about 20 seconds for the exercise to be prepared and buttons updated. You will continue working from your copy of the exercise.
- The **Copy Exercise** button will deactivate, changing to gray.
- The **Start Exercise** button will activate, changing to green.
- You will likely need to refresh the page.
Once the repository is created, GitHub will automatically prepare the exercise.

4. Click **Start Exercise**. Follow the step-by-step instructions and feedback will be provided as you progress.
- Wait ~20 seconds.
- The **Copy Exercise** button will turn gray.
- The **Start Exercise** button will activate (turn green).
- Refresh the page if needed.

### 3. Start the Exercise

Click the green button to begin:

<a id="start-exercise">
<img src="https://img.shields.io/badge/🚀_Start_Exercise-AAA" height="25pt"/>
</a>

Follow the step-by-step instructions. GitHub will provide feedback as you go.

> ⚠️ **Note:** The **Start Exercise** button appears after the repository is copied. If you don’t see it, refresh the page.
---

<a id="start-exercise">
<img src="https://img.shields.io/badge/🚀_Start_Exercise-AAA" height="25pt"/>
</a>
## 🙌 You're on your way!

> [!IMPORTANT]
> The **Start Exercise** button will activate after copying the repository. You will probably need to refresh the page.
Once you’ve completed this, you’ll know the core workflow of GitHub — a powerful skill that applies to nearly every modern development project.

---

&copy; 2025 GitHub &bull; [Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md) &bull; [MIT License](https://gh.io/mit)
&copy; 2025 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)