存储库快速入门

了解如何在 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. 按照交互式提示进行操作。要克隆本地存储库，当询问您是否要克隆远程项目目录时，请确认是。
  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

后续步骤

您现在已经创建了一个存储库，其中包括一个自述文件，并在 GitHub.com 上创建了您的第一个提交。

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

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

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

  • GitHub 有一个强大的支持社区，您可以在其中寻求帮助并与来自世界各地的人们交谈。加入 GitHub 社区 中的讨论。