跳到主要内容

你好,世界

按照此 Hello World 练习了解 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 流程”。

  4. 选择你的存储库是公开还是私有

  5. 选择添加 README 文件

  6. 单击创建存储库

步骤 2:创建分支

分支让你可以同时拥有存储库的不同版本。

默认情况下,你的存储库有一个名为 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. 点击 创建分支:readme-edits from main

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

现在你有两个分支,mainreadme-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 技能“审查请求”课程。

步骤 5:合并您的请求

在此最后一步中,您将把您的readme-edits分支合并到main分支中。在合并请求后,您的readme-edits分支上的更改将合并到main中。

有时,请求可能会引入与main上现有代码冲突的代码更改。如果有任何冲突,GitHub 会向您发出有关冲突代码的警报,并在冲突解决之前阻止合并。您可以提交一个解决冲突的提交,或在请求中使用评论与您的团队成员讨论冲突。

在此演练中,您不应该有任何冲突,因此您可以准备将您的分支合并到主分支中。

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

结论

通过完成本教程,您已学会在 GitHub 上创建项目并提出请求。

作为其中的一部分,我们已学会如何

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

下一步

  • 查看您的 GitHub 个人资料,您将看到您的工作反映在您的贡献图上。
  • 如果您想再次练习在本教程中学到的技能,请尝试GitHub 技能“GitHub 简介”课程。
  • 在下一教程“设置您的个人资料”中,您将学习如何个性化您的个人资料,还将学习一些基本的 Markdown 语法,以便在 GitHub 上编写内容。

延伸阅读