1
0
mirror of synced 2025-12-21 02:46:50 -05:00
Files
docs/content/get-started/quickstart/create-a-repo.md
2021-06-22 17:15:04 +00:00

5.5 KiB

title, redirect_from, intro, versions, topics
title redirect_from intro versions topics
Create a repo
/create-a-repo/
/articles/create-a-repo
/github/getting-started-with-github/create-a-repo
/github/getting-started-with-github/quickstart/create-a-repo
To put your project up on {% data variables.product.product_location %}, you'll need to create a repository for it to live in.
free-pro-team enterprise-server github-ae
* * *
Pull requests
Issues
Notifications
Accounts

Create a repository

{% if currentVersion == "free-pro-team@latest" %}

You can store a variety of projects in {% data variables.product.product_name %} repositories, including open source projects. With open source projects, you can share code to make better, more reliable software. You can use repositories to collaborate with others and track your work. For more information, see "About repositories."

{% elsif enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}

You can store a variety of projects in {% data variables.product.product_name %} repositories, including innersource projects. With innersource, you can share code to make better, more reliable software. For more information on innersource, see {% data variables.product.company_short %}'s white paper "An introduction to innersource."

{% endif %}

{% if currentVersion == "free-pro-team@latest" %}

{% note %}

Note: You can create public repositories for an open source project. When creating your public repository, make sure to include a license file that determines how you want your project to be shared with others. {% data reusables.open-source.open-source-guide-repositories %} {% data reusables.open-source.open-source-learning-lab %}

{% endnote %}

{% endif %}

{% data reusables.repositories.create_new %} 2. Type a short, memorable name for your repository. For example, "hello-world". Field for entering a repository name 3. Optionally, add a description of your repository. For example, "My first repository on {% data variables.product.product_name %}." Field for entering a repository description {% data reusables.repositories.choose-repo-visibility %} {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %}

Congratulations! You've successfully created your first repository, and initialized it with a README file.

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} {% tip %}

Tip: You can also create repositories using the {% data variables.product.prodname_cli %}. For more information, see "gh repo create" in the {% data variables.product.prodname_cli %} documentation.

{% endtip %} {% endif %}

Commit your first change

A commit is like a snapshot of all the files in your project at a particular point in time.

When you created your new repository, you initialized it with a README file. README files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your README file are automatically shown on the front page of your repository.

Let's commit a change to the README file.

  1. In your repository's list of files, click README.md. README file in file list
  2. Above the file's content, click {% octicon "pencil" aria-label="The edit icon" %}.
  3. On the Edit file tab, type some information about yourself. New content in file {% data reusables.files.preview_change %}
  4. Review the changes you made to the file. You'll see the new content in green. File preview view {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_file_change %}

Celebrate

Congratulations! You have now created a repository, including a README file, and created your first commit on {% data variables.product.product_location %}.

You can now clone a {% data variables.product.product_name %} repository to create a local copy on your computer. From your local repository you can commit, and create a pull request to update the changes in the upstream repository. For more information, see "Cloning a repository" and "Set up Git."

You can find interesting projects and repositories on {% data variables.product.product_name %} and make changes to them by creating a fork of the repository. For more information see, "Fork a repository."

Each repository in {% data variables.product.product_name %} is owned by a person or an organization. You can interact with the people, repositories, and organizations by connecting and following them on {% data variables.product.product_name %}. For more information see "Be social."

{% data reusables.support.connect-in-the-forum-bootcamp %}