跳至主要内容

你好,世界

跟随此“你好,世界”练习学习 GitHub 的拉取请求工作流。

简介

本教程教您 GitHub 基础知识,如仓库、分支、提交和拉取请求。您将创建自己的“你好,世界”仓库,并学习 GitHub 的拉取请求工作流,这是一种流行的代码创建与审查方式。

在本快速入门指南中,您将

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

先决条件

  • 您必须拥有一个 GitHub 账户。欲了解更多信息,请参见 在 GitHub 上创建账户

  • 您不需要了解如何编写代码、使用命令行或安装 Git(GitHub 所基于的版本控制软件)。

步骤 1:创建仓库

我们要做的第一件事是创建一个仓库。您可以将仓库视为一个文件夹,里面包含相关的项目,例如文件、图片、视频,甚至其他文件夹。仓库通常将属于同一“项目”或同一工作内容的项目归为一组。

通常,仓库会包含一个 README 文件,用于提供项目的相关信息。README 文件使用 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 分支
  • 名为 feature 的新分支
  • feature 在合并到 main 之前,经历“提交更改”“提交拉取请求”“讨论拟议更改”等阶段的过程。

Diagram of the two branches. The "feature" branch diverges from the "main" branch 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.

现在您有两个分支,mainreadme-edits。此时它们完全相同。接下来您将在新建的 readme-edits 分支上添加更改。

步骤 3:进行并提交更改

在上一步创建新分支后,GitHub 将您带到新 readme-edits 分支的代码页面,该页面是 main 的副本。

您可以对仓库中的文件进行更改并保存。在 GitHub 上,已保存的更改称为提交。每个提交都有关联的提交信息,描述了为何进行特定更改。提交信息记录了更改历史,其他贡献者可以了解您做了什么以及原因。

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

这些更改仅会作用于 readme-edits 分支的 README 文件,因此该分支的内容已与 main 不同。

步骤 4:打开拉取请求

现在您在 main 分支的一个子分支上已有更改,可以打开拉取请求。

拉取请求是 GitHub 协作的核心。当您打开拉取请求时,您在提出更改并请求他人审阅、合并这些贡献到他们的分支。拉取请求会显示两个分支内容的差异(diff),并以不同颜色标示新增、删除和修改的部分。

只要您提交一次更改,即可打开拉取请求并开始讨论,即使代码尚未完成。

在此步骤中,您将在自己的仓库中打开拉取请求并自行合并。这是练习 GitHub Flow 的好方法,为后续处理更大型项目做好准备。

  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 会提示并阻止合并,直至冲突解决。您可以提交解决冲突的提交,或在拉取请求中使用评论与团队成员讨论冲突。

在本演练中,您不应遇到任何冲突,因此可以直接将分支合并到主分支。

  1. 在拉取请求底部,点击 Merge pull request 将更改合并到 main
  2. 点击 Confirm merge。系统会提示拉取请求已成功合并并关闭。
  3. 点击 Delete branch。拉取请求已合并且更改已在 main 上后,您可以安全地删除 readme-edits 分支。如果想再次更改项目,随时可以新建分支并重复此过程。
  4. 返回您 hello-world 仓库的 代码 选项卡,查看已发布到 main 的更改。

结论

完成本教程后,您已经学会在 GitHub 上创建项目并发起拉取请求。

其中包括以下内容:

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

后续步骤

  • 查看您的 GitHub 个人资料,您将看到贡献图中已显示您的工作。
  • 如果您想再次练习本教程中学到的技能,请尝试 GitHub Skills 的“GitHub 入门”课程。
  • 在下一个教程 设置个人资料 中,您将学习如何个性化个人资料,并掌握在 GitHub 上撰写内容的基本 Markdown 语法。

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.