GitHub 指南

mywang88

2018-12-30

简介

学习使用 GitHub ，顺手翻译了下它的用户指南。

主页：https://github.com/

指南：https://guides.github.com/activities/hello-world/

Hello World 项目是计算机编程界的一个历史悠久的传统。当你开始学习一个新的东西的时候，它是一个简单的小练习。让我们开始学习 GitHub 吧！

你将学会：

• 创建和使用一个仓库（repository）
• 开始和管理一个新的分支（branch）
• 对一个文件进行更改，并将其作为提交（commits），推送（push）到 GitHub
• 打开并**合并（merge）**一个 pull 请求

GitHub 是什么

GitHub 是一个用于版本控制和写作的代码托管平台。它可以让你和其他人在任何地方一起工作。

本教程将介绍 GitHub 的基本功能，如仓库（repository）、分支（branch）、提交（commits）和拉取请求（pull requests）。你将创建自己的 Hello World 仓库并学习 GitHub 的 Pull Request 工作流，这是一种创建和检查代码的流行方式。

无需编程

要完成本教程，你需要一个 GitHub 账户，并将你的电脑连接到因特网。你不需要知道如何编程，如何使用命令行，以及如何安装 Git 。Git 是一个版本控制软件，GitHub 就是构建在 Git 之上。

第一步 创建一个仓库（repository）

仓库（repository）通常用来组织单个项目。仓库中可以包含文件夹和文件、图像、视频、电子表格、数据库、以及项目需要的任何其它东西。我们建议你在你的项目中包含一个 README
文件，或者其它形式的包含了你的项目信息的文件。在你创建你的新仓库的同时，GitHub 提供了为其创建一个 README 文件的选项。GitHub 也提供了其它常用的选项，例如一份许可文件。

你的 hello-world 仓库可以是一个你用来储存想法和资源的地方，你甚至可以在里面和别人分享讨论问题。

创建一个新的仓库

1. 在 GitHub 主页的右上角，在你的头像或图标的旁边，点击那个 + 按钮，在下拉菜单中选择 New repository ，即“新仓库”。

2. 在 Repository name 中输入你的仓库名称，例如 hello-world 。

3. 在 Description (optional) 中写一个简短的描述。

4. 勾选 Initialize this repository with a README 选项，为这个新创建的仓库生成一个 README 文件。

5. 点击 Create repository ，创建仓库。

第二步 创建一个分支

分支是同时处理仓库的不同版本的方法。

默认情况下，你的仓库有一个名为 master 的分支，它被认为是最终分支。我们使用其它的分支来进行实验和编辑，最终将它们提交给 master 分支。

当你从 master 分支创建一个新的分支时，你实际上是在复制 master 分支。如果其他人在你处理你的分支时，对 master 分支进行了更改，您可以将这些更新“拉（pull）”进来。

下面的示意图展示了：

• master 分支
• 一个叫做 feature 的新分支
• feature 分支在被合并（merge）进 master 分支之前经历的旅程

你是否曾经保存过一个文件的不同版本？就像这样：

• story.txt
• story-joe-edit.txt
• story-joe-edit-reviewed.txt

分支（Branch）在 GitHub 仓库中实现的就是类似的目标。

在 GitHub 中，我们的开发人员、作者和设计师门使用分支（branch），来将 bug 修复和特性工作等与 master 分支（产品分支）分离开来。当一个对程序的改动开发完成后，他们再将该分支合并到 master 分支中。

创建一个新的分支

1. 进入你的新仓库 hello-world
2. 点击 Branch: master 按钮，弹出下拉框
3. 在 Find or create a branch... 输入框中输入要创建的分支的名字 readme-edits
4. 点击蓝色的 Create branch: readme-edits 按钮，或在键盘上敲回车键

现在你有两个分支了，它们分别是 master 分支和 readme-edits 分支。它们看起来是完全一样的，但不会一直如此。接下来，我们将向新的分支（readme-edits）添加修改。

第三步 进行和提交修改

好极了，现在，你在你的 readme-edits 分支的 Code 页面（选项卡）下，它是你的 master 分支的一个副本。让我们来进行一些编辑。

在 GitHub 上，被保存了的修改，称为提交（commits）。每一个提交，都有一个与它相关联的“提交信息”，“提交信息”描述和解释了为什么要进行本次修改。“提交消息”们记录了你进行修改的历史，这样，其他贡献者就能理解你曾经做了什么，以及为什么要那么做。

进行和提交修改

1. 点击 README.md 文件，在大多数浏览器中，它是一个蓝色字体的超链接。
2. 在新进入的页面中，点击右侧的铅笔图标。当你指向它时，会显示 Edit this file 。
3. 在新进入的页面的编辑区域，随便写点什么。
4. 在下方的 Commit changes 下的文本框中输入描述你所做的修改的“提交信息”。
5. 点击 Commit changes 按钮。

你所做的修改，将只作用于你的 readme-edits 分支的 README.md 文件，因此，现在这个分支已经包含了与 master 分支不同的内容。

第四步 发出一个 Pull 请求

现在，你已经在（从 master 分支分离出的） readme-edits 分支中进行了修改，那么你可以发出一个 pull 请求。

Pull 请求是 GitHub 上协作的核心。当你发出一个 pull 请求时，你是在提议你的更改，并请求某人审查和提取你的贡献，并将它们合并到他的分支中。Pull 请求会显示两个分支的内容的差异。变化、加法和减法用绿色和红色表示。

实际上，一旦你在你的分支（branch）中进行了提交（commit），你就可以发出一个 pull 请求，并开始讨论，甚至在你的代码完成之前。

通过在 pull 请求消息中使用 GitHub 的 @mention 系统，你可以向特定的人或团队请求反馈，无论他们是在走廊那头还是10个时区之外。

你甚至可以在自己的仓库中发出 pull 请求，然后自己合并它们。在进行大型项目之前，这是学习 GitHub 流的好方法。

为对 README 文件的修改打开一个 pull 请求

1. 进入 hello-world 项目的 readme-edits 分支，点击上方的 Pull requests 选项卡，然后点击右侧的绿色的 New pull request 按钮。

2. 在进入的页面中，将 base: 按钮选为 master，这一般是默认的；将 compare: 按钮选为 readme-edits 。

3. 在 Compare changes 页面查看你所进行的更改，确认它们是你想提交的。

4. 确认好后，点击绿色的 Create Pull Request 按钮。

5. 在 Open a pull request 页面给你的 pull 请求一个标题，为你所做的更改，写一个简单的描述。

6. 都填写完成后，点击右下角绿色的 Create pull request 按钮。

第五步 合并你的 pull 请求

这是最后一步，将你修改过的的 readme-edits 分支合并进 master 分支。

1. 进入你的 hello-world 仓库，点击 Code 和 Issues 选项卡右边的 Pull requests 选项卡（它右边应该显示了数字“1”）。

2. 在下方，你可以找到你刚刚发出的 pull 请求 Readme edits ，点击它。

3. 在新进入的页面中点击绿色的 Merge pull request 按钮，将更改合并进 master 分支。

4. 点击绿色的 Confirm merge 按钮，确认合并。

5. 继续并删除 readme-edits 分支，因为它的更改已经被合并，紫色框中有 delete branch 按钮。

庆祝！

通过完成本教程，您已经学会了在 GitHub 上创建一个项目（仓库）并发出一个 pull 请求。

以下是你在本教程中完成的：

• 创建一个开源仓库
• 创建并管理一个新的分支
• 更改一个文件并将更改内容提交到 GitHub
• 发出并合并一个 pull 请求

查看你的 GitHub 主页，你将发现你的新的“贡献方块”。

要了解更多关于 pull 请求的功能，我们建议阅读《 GitHub 流指南》。你还可以访问 GitHub Explore 并参与一个开源项目。

最后更新日期：2016年 4月 7日