153 lines
11 KiB
Markdown
153 lines
11 KiB
Markdown
---
|
||
title: Hello World
|
||
intro: 'Follow this Hello World exercise to get started with {% data variables.product.product_name %}.'
|
||
versions:
|
||
fpt: '*'
|
||
ghes: '*'
|
||
ghae: '*'
|
||
ghec: '*'
|
||
type: quick_start
|
||
topics:
|
||
- Pull requests
|
||
- Fundamentals
|
||
---
|
||
|
||
## Introduction
|
||
|
||
{% data variables.product.product_name %} is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.
|
||
|
||
This tutorial teaches you {% data variables.product.product_name %} essentials like repositories, branches, commits, and pull requests. You'll create your own Hello World repository and learn {% data variables.product.product_name %}'s pull request workflow, a popular way to create and review code.
|
||
|
||
In this quickstart guide, you will:
|
||
|
||
- Create and use a repository
|
||
- Start and manage a new branch
|
||
- Make changes to a file and push them to {% data variables.product.product_name %} as commits
|
||
- Open and merge a pull request
|
||
|
||
To complete this tutorial, you need a [{% data variables.product.product_name %} account](http://github.com) and Internet access. You don't need to know how to code, use the command line, or install Git (the version control software that {% data variables.product.product_name %} is built on). If you have a question about any of the expressions used in this guide, head on over to the [glossary](/get-started/quickstart/github-glossary) to find out more about our terminology.
|
||
|
||
## Creating a repository
|
||
|
||
A repository is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets -- anything your project needs. Often, repositories include a README file, a file with information about your project. README files are written in the plain text Markdown language. You can use this [cheat sheet](https://www.markdownguide.org/cheat-sheet/) to get started with Markdown syntax. {% data variables.product.product_name %} lets you add a README file at the same time you create your new repository. {% data variables.product.product_name %} also offers other common options such as a license file, but you do not have to select any of them now.
|
||
|
||
Your `hello-world` repository can be a place where you store ideas, resources, or even share and discuss things with others.
|
||
|
||
{% data reusables.repositories.create_new %}
|
||
1. In the "Repository name" box, type `hello-world`.
|
||
1. In the "Description" box, type a short description.
|
||
1. Select whether your repository will be **Public** or **Private**.
|
||
1. Select **Add a README file**.
|
||
1. Click **Create repository**.
|
||
|
||
## Creating a branch
|
||
|
||
Branching lets you have different versions of a repository at one time.
|
||
|
||
By default, your repository has one branch named `main` that 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. This is helpful when you want to add new features to a project without changing the main source of code. The work done on different branches will not show up on the main branch until you merge it, which we will cover later in this guide. You can use branches to experiment and make edits before committing them to `main`.
|
||
|
||
When you create a branch off the `main` branch, you're making a copy, or snapshot, of `main` as it was at that point in time. If someone else made changes to the `main` branch while you were working on your branch, you could pull in those updates.
|
||
|
||
This diagram shows:
|
||
|
||
- The `main` branch
|
||
- A new branch called `feature`
|
||
- The journey that `feature` takes before it's merged into `main`
|
||
|
||
|
||
|
||
Have you ever saved different versions of a file? Something like:
|
||
|
||
- `story.txt`
|
||
- `story-edit.txt`
|
||
- `story-edit-reviewed.txt`
|
||
|
||
Branches accomplish similar goals in {% data variables.product.product_name %} repositories.
|
||
|
||
Here at {% data variables.product.product_name %}, our developers, writers, and designers use branches for keeping bug fixes and feature work separate from our `main` (production) branch. When a change is ready, they merge their branch into `main`.
|
||
|
||
### Create a branch
|
||
|
||
1. Click the **Code** tab of your `hello-world` repository.
|
||
1. Above the file list, click the dropdown menu that says **main**.
|
||
|
||
|
||
1. Type a branch name, `readme-edits`, into the text box.
|
||
1. Click **Create branch: readme-edits from main**.
|
||
|
||
|
||
Now you have two branches, `main` and `readme-edits`. Right now, they look exactly the same. Next you'll add changes to the new branch.
|
||
|
||
## Making and committing changes
|
||
|
||
When you created a new branch in the previous step, {% data variables.product.product_name %} brought you to the code page for your new `readme-edits` branch, which is a copy of `main`.
|
||
|
||
You can make and save changes to the files in your repository. On {% data variables.product.product_name %}, saved changes are called commits. Each commit has an associated commit message, which is a description explaining why a particular change was made. Commit messages capture the history of your changes so that other contributors can understand what you’ve done and why.
|
||
|
||
1. Under the `readme-edits` branch you created, click the _README.md_ file.
|
||
1. To edit the file, click {% octicon "pencil" aria-label="Edit file" %}.
|
||
1. In the editor, write a bit about yourself. Try using different Markdown elements.
|
||
{% ifversion code-search-code-view %}
|
||
1. Click **Commit changes...**.
|
||
1. In the "Propose changes" box, write a commit message that describes your changes.
|
||
1. Click **Propose changes**.
|
||
{% else %}
|
||
1. In the "Commit changes" box, write a commit message that describes your changes.
|
||
1. Click **Commit changes**.
|
||
{% endif %}
|
||
|
||
These changes will be made only to the README file on your `readme-edits` branch, so now this branch contains content that's different from `main`.
|
||
|
||
## Opening a pull request
|
||
|
||
Now that you have changes in a branch off of `main`, you can open a pull request.
|
||
|
||
Pull requests are the heart of collaboration on {% data variables.product.product_name %}. When you open a pull request, you're proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests show diffs, or differences, of the content from both branches. The changes, additions, and subtractions are shown in different colors.
|
||
|
||
As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.
|
||
|
||
By using {% data variables.product.product_name %}'s `@mention` feature in your pull request message, you can ask for feedback from specific people or teams, whether they're down the hall or 10 time zones away.
|
||
|
||
You can even open pull requests in your own repository and merge them yourself. It's a great way to learn the {% data variables.product.product_name %} flow before working on larger projects.
|
||
|
||
1. Click the **Pull requests** tab of your `hello-world` repository.
|
||
1. Click **New pull request**
|
||
1. In the **Example Comparisons** box, select the branch you made, `readme-edits`, to compare with `main` (the original).
|
||
1. Look over your changes in the diffs on the Compare page, make sure they're what you want to submit.
|
||
|
||
|
||
|
||
1. Click **Create pull request**.
|
||
1. Give your pull request a title and write a brief description of your changes. You can include emojis and drag and drop images and gifs.
|
||
1. Optionally, to the right of your title and description, click the {% octicon "gear" aria-label="The Gear icon" %} next to **Reviewers**, **Assignees**, **Labels**, **Projects**, or **Milestone** to add any of these options to your pull request. You do not need to add any yet, but these options offer different ways to collaborate using pull requests. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."
|
||
1. Click **Create pull request**.
|
||
|
||
Your collaborators can now review your edits and make suggestions.
|
||
|
||
## Merging your pull request
|
||
|
||
In this final step, you will merge your `readme-edits` branch into the `main` branch. After you merge your pull request, the changes on your `readme-edits` branch will be incorporated into `main`.
|
||
|
||
Sometimes, a pull request may introduce changes to code that conflict with the existing code on `main`. If there are any conflicts, {% data variables.product.product_name %} will alert you about the conflicting code and prevent merging until the conflicts are resolved. You can make a commit that resolves the conflicts or use comments in the pull request to discuss the conflicts with your team members.
|
||
|
||
In this walk-through, you should not have any conflicts, so you are ready to merge your branch into the main branch.
|
||
|
||
1. At the bottom of the pull request, click **Merge pull request** to merge the changes into `main`.
|
||
1. Click **Confirm merge**. You will receive a message that the request was successfully merged and the request was closed.
|
||
1. Click **Delete branch**. Now that your pull request is merged and your changes are on `main`, you can safely delete the `readme-edits` branch. If you want to make more changes to your project, you can always create a new branch and repeat this process.
|
||
|
||
## Next steps
|
||
|
||
By completing this tutorial, you've learned to create a project and make a pull request on {% data variables.product.product_name %}.
|
||
|
||
Here's what you accomplished in this tutorial:
|
||
|
||
- Created an open source repository
|
||
- Started and managed a new branch
|
||
- Changed a file and committed those changes to {% data variables.product.product_name %}
|
||
- Opened and merged a pull request
|
||
|
||
Take a look at your {% data variables.product.product_name %} profile and you'll see your work reflected on your contribution graph.
|
||
|
||
For more information about the power of branches and pull requests, see "[AUTOTITLE](/get-started/quickstart/github-flow)." For more information about getting started with {% data variables.product.product_name %}, see the other guides in the [getting started quickstart](/get-started/quickstart).
|