你好，世界

按照此“你好，世界”练习学习 GitHub 的拉取请求工作流。

本文内容

简介

本教程将教你 GitHub 的基本知识，例如仓库、分支、提交和拉取请求。你将创建自己的 Hello World 仓库，并学习 GitHub 的拉取请求工作流，这是一种创建和审查代码的常用方法。

在本快速入门指南中，你将

  • 创建并使用仓库。
  • 启动和管理新分支。
  • 更改文件并将其作为提交推送到 GitHub。
  • 打开并合并拉取请求。

先决条件

  • 你必须拥有一个 GitHub 帐户。有关更多信息，请参阅“在 GitHub 上创建帐户”。

  • 你无需了解如何编写代码、使用命令行或安装 Git（GitHub 所基于的版本控制软件）。

步骤 1：创建仓库

我们要做的第一件事是创建一个仓库。你可以将仓库视为一个包含相关项目的文件夹，例如文件、图像、视频，甚至其他文件夹。仓库通常将属于同一“项目”或你正在处理的事物的项目组合在一起。

仓库通常包含一个 README 文件，这是一个包含有关项目的信息的文件。README 文件使用 Markdown 编写，Markdown 是一种易于阅读、易于编写的用于格式化纯文本的语言。我们将在下一教程“设置你的个人资料”中详细了解 Markdown。

GitHub 允许你在创建新仓库的同时添加 README 文件。GitHub 还提供其他常见选项，例如许可证文件，但你现在不必选择任何选项。

你的 hello-world 仓库可以作为你存储想法、资源，甚至与他人共享和讨论内容的地方。

  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。

  3. 在“描述”框中，键入简短的描述。例如，键入“此仓库用于练习 GitHub Flow”。

  4. 选择你的仓库是**公开**还是**私有**。

  5. 选择**添加 README 文件**。

  6. 点击**创建仓库**。

步骤 2：创建分支

分支允许你同时拥有仓库的不同版本。

默认情况下，你的仓库有一个名为 main 的分支，该分支被视为最终分支。你可以在仓库中从 main 创建其他分支。

当你想要向项目添加新功能而不更改主要代码源时，分支非常有用。在不同分支上完成的工作不会显示在 main 分支上，直到你将其合并，我们将在本指南的后面部分介绍。你可以在将更改提交到 main 之前使用分支进行实验和编辑。

当你从 main 分支创建分支时，你正在创建 main 的副本或快照，该副本或快照是在特定时间点创建的。如果其他人在你处理分支时对 main 分支进行了更改，则可以提取这些更新。

此图显示

  • main 分支
  • 一个名为 feature 的新分支
  • feature 在合并到 main 之前所经历的过程

Diagram of the two branches. The "feature" branch diverges from the "main" branch, goes through stages for "Commit changes," "Submit pull request," and "Discuss proposed changes," and is then merged back into main.

创建分支

  1. 点击你的 hello-world 仓库的**代码**选项卡。

  2. 在文件列表上方，点击显示**main**的下拉菜单。

    Screenshot of the repository page. A dropdown menu, labeled with a branch icon and "main", is highlighted with an orange outline.

  3. 在文本框中键入分支名称 readme-edits。

  4. 点击**创建分支：从 main 创建 readme-edits**。

    Screenshot of the branch dropdown for a repository. "Create branch: readme-edits from 'main'" is outlined in dark orange.

现在你拥有了两个分支，main 和 readme-edits。目前，它们看起来完全相同。接下来，你将向新的 readme-edits 分支添加更改。

步骤 3：进行更改并提交

在上一步骤中创建新分支时，GitHub 将你带到新 readme-edits 分支的代码页面，该分支是 main 的副本。

你可以对仓库中的文件进行更改并保存更改。在 GitHub 上，保存的更改称为提交。每个提交都与一个关联的提交消息相关联，该消息是对解释为何进行特定更改的原因的描述。提交消息捕获更改的历史记录，以便其他贡献者能够了解你所做的事情以及原因。

  1. 在你创建的 readme-edits 分支下，点击 README.md 文件。
  2. 要编辑文件，请点击.
  3. 在编辑器中，写一些关于你自己的内容。
  4. 点击**提交更改**。
  5. 在“提交更改”框中，编写一条描述更改的提交消息。
  6. 点击**提交更改**。

这些更改将仅对 readme-edits 分支上的 README 文件进行，因此现在此分支包含与 main 不同的内容。

步骤 4：打开拉取请求

现在你已在 main 的分支中进行了更改，你可以打开拉取请求。

拉取请求是 GitHub 上协作的核心。当你打开拉取请求时，你是在提议你的更改并请求某人审查并提取你的贡献并将其合并到他们的分支中。拉取请求显示来自两个分支的内容的差异或区别。更改、添加和删除以不同的颜色显示。

一旦你进行提交，你就可以打开拉取请求并开始讨论，即使代码尚未完成。

在此步骤中，你将在自己的仓库中打开拉取请求，然后自行合并它。这是一种在处理大型项目之前练习 GitHub 工作流的好方法。

  1. 点击你的 hello-world 仓库的**拉取请求**选项卡。

  2. 点击**新建拉取请求**。

  3. 在**示例比较**框中，选择你创建的分支 readme-edits 以与 main（原始分支）进行比较。

  4. 查看比较页面上的差异中的更改，确保它们是你想要提交的更改。

    Screenshot of a diff for the README.md file. 3 red lines list the text that's being removed, and 3 green lines list the text being added.

  5. 点击**创建拉取请求**。

  6. 为你的拉取请求提供标题，并编写简要描述你的更改。你可以包含表情符号并拖放图像和 GIF。

  7. 点击**创建拉取请求**。

审查拉取请求

当你开始与他人协作时，此时你将请求他们的审查。这允许你的合作者在将更改合并到 main 分支之前，对你的拉取请求发表评论或提出更改建议。

我们不会在本教程中介绍如何审查拉取请求，但如果你有兴趣了解更多信息，请参阅“关于拉取请求审查”。或者，尝试 GitHub Skills 的“审查拉取请求”课程。

步骤 5：合并你的拉取请求

在此最后一步中，你将把 readme-edits 分支合并到 main 分支中。合并拉取请求后，readme-edits 分支上的更改将并入 main。

有时，拉取请求可能会引入与 main 上的现有代码冲突的代码更改。如果存在任何冲突，GitHub 将会提醒你有关冲突代码的信息，并在冲突解决之前阻止合并。你可以进行解决冲突的提交，或者使用拉取请求中的评论与团队成员讨论冲突。

在本演练中，你不应该有任何冲突，因此你可以将你的分支合并到 main 分支中。

  1. 在拉取请求底部，点击**合并拉取请求**以将更改合并到 main 中。
  2. 点击**确认合并**。你将收到一条消息，表明请求已成功合并且请求已关闭。
  3. 点击**删除分支**。现在你的拉取请求已合并，你的更改已在 main 上，你可以安全地删除 readme-edits 分支。如果你想对项目进行更多更改，可以随时创建新分支并重复此过程。
  4. 点击返回到 hello-world 仓库的**代码**选项卡，以查看 main 上已发布的更改。

结论

通过完成本教程，你已学会在 GitHub 上创建项目并发出拉取请求。

作为其中的一部分，我们学习了如何

  • 创建仓库。
  • 启动和管理新分支。
  • 更改文件并将这些更改提交到 GitHub。
  • 打开并合并拉取请求。

后续步骤

  • 查看你的 GitHub 个人资料，你将看到你的工作反映在你的贡献图中。
  • 如果你想再次练习在本教程中学到的技能，请尝试 GitHub Skills 的“GitHub 入门”课程。
  • 在下一教程“设置你的个人资料”中，你将学习如何个性化你的个人资料，并且还将学习一些用于在 GitHub 上编写内容的基本 Markdown 语法。

进一步阅读