仓库快速入门

学习如何在 5 分钟内创建新仓库并提交您的第一个更改。

本文档

创建仓库

GitHub 仓库存储各种项目。在本指南中，您将创建一个仓库并提交您的第一个更改。

  1. 在任何页面的右上角，选择 ，然后点击新建仓库。

    Screenshot of a GitHub dropdown menu showing options to create new items. The menu item "New repository" is outlined in dark orange.

  2. 为您的仓库输入一个简短且易记的名称。例如，“hello-world”。

    Screenshot of the first step in creating a GitHub repository. The "Repository name" field contains the text "hello-world" and is outlined in dark orange.

  3. 可选地，添加仓库的描述。例如，“我在 GitHub 上的第一个仓库”。

  4. 选择仓库可见性。有关更多信息，请参阅“关于仓库”。

  5. 选择使用 README 初始化此仓库。

  6. 点击创建仓库。

恭喜！您已成功创建您的第一个仓库，并使用README文件对其进行了初始化。

要了解有关 GitHub CLI 的更多信息，请参阅“关于 GitHub CLI”。

  1. 在命令行中，导航到您要创建新项目本地克隆的目录。
  2. 要为您的项目创建仓库，请使用 `gh repo create` 子命令。在提示时，选择 **从头开始在 GitHub 上创建一个新仓库** 并输入新项目的名称。如果您希望您的项目属于某个组织而不是您的个人帐户，请使用 `organization-name/project-name` 指定组织名称和项目名称。
  3. 按照交互式提示操作。要将仓库克隆到本地，在询问您是否要克隆远程项目目录时确认 yes。
  4. 或者，要跳过提示，请提供仓库名称和可见性标志（`--public`、`--private` 或 `--internal`）。例如，`gh repo create project-name --public`。要将仓库克隆到本地，请传递 `--clone` 标志。有关可能参数的更多信息，请参阅 GitHub CLI 手册。

提交您的第一个更改

一个 提交 就像对项目中所有文件在特定时间点的快照。

创建新仓库时，您会使用一个 README 文件对其进行初始化。README 文件是详细描述您的项目或添加一些文档（例如如何安装或使用您的项目）的好地方。您的 README 文件的内容会自动显示在仓库首页上。

让我们提交对 README 文件的更改。

  1. 在仓库的文件列表中，选择 **README.md**。

    Screenshot of a list of files in a repository. A file name, "README.md", is highlighted with an orange outline.

  2. 在文件视图的右上角，单击 以打开文件编辑器。

    Screenshot of a file. In the header, a button, labeled with a pencil icon, is outlined in dark orange.

  3. 在文本框中，键入一些关于您自己的信息。

  4. 在新内容上方，单击 **预览**。

    Screenshot of a file in edit mode. Above the file's contents, a tab labeled "Preview" is outlined in dark orange.

  5. 查看您对文件所做的更改。如果您选择 **显示差异**，您将看到新内容以绿色显示。

    Screenshot of the "Preview" view for a file. A checkbox labeled "Show diff" is selected, and an addition to the file is indicated by a green line marker. Both are outlined in orange.

  6. 单击 **提交更改...**

  7. 在“提交消息”字段中，键入简短且有意义的提交消息，描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。有关更多信息，请参阅“创建具有多个作者的提交”。

  8. 在提交消息字段下方，决定是将您的提交添加到当前分支还是添加到新分支。如果您的当前分支是默认分支，您应该选择为您的提交创建一个新分支，然后创建一个拉取请求。有关更多信息，请参阅“创建拉取请求”。

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  9. 单击 **提交更改** 或 **提出更改**。

现在您已经创建了一个项目，您可以开始提交更改了。

README 文件是详细描述您的项目或添加一些文档（例如如何安装或使用您的项目）的好地方。README 文件的内容会自动显示在您的仓库首页上。请按照以下步骤添加 README 文件。

  1. 在命令行中，导航到新项目的根目录。（此目录是在您运行 gh repo create 命令时创建的。）

  2. 创建一个包含项目信息的 README 文件。

    echo "info about this project" >> README.md

  3. 输入 git status。您将看到有一个未跟踪的 README.md 文件。

    $ git status

Untracked files:
  (use "git add <file>..." to include in what will be committed)
  README.md

nothing added to commit but untracked files present (use "git add" to track)

  4. 暂存并提交该文件。

    git add README.md && git commit -m "Add README"

  5. 将更改推送到您的分支。

    git push --set-upstream origin HEAD

下一步

您现在已经创建了一个仓库，包括一个 README 文件，并在 GitHub.com 上创建了您的第一个提交。

  • 您现在可以克隆 GitHub 仓库，在您的计算机上创建一个本地副本。从您的本地仓库，您可以提交并创建一个拉取请求，以更新上游仓库中的更改。有关更多信息，请参阅 "克隆仓库" 和 "设置 Git。"。

  • 您可以在 GitHub 上找到有趣的项目和仓库，并通过创建仓库的分支来对其进行更改。分叉仓库将允许您对另一个仓库进行更改，而不会影响原始仓库。有关更多信息，请参阅 "分叉仓库。"。

  • GitHub 上的每个仓库都归个人或组织所有。您可以通过在 GitHub 上连接和关注他们来与这些人、仓库和组织互动。有关更多信息，请参阅 "在 GitHub 上寻找灵感。"。

  • GitHub 拥有一个很棒的支持社区，您可以在其中寻求帮助并与来自世界各地的人们交流。加入 GitHub 社区 的对话。