github官方新手指南—Hello World

原文:https://guides.github.com/activities/hello-world/


目录

什么是GitHub?

第一步 创建一个仓库(repository)

第二步 创建分支

第三步 完成并提交修改

第四步 打开Pull请求

第五步 合并你的Pull请求


Hello World 项目在计算机程序中是一个经典的例子。学习新知识时Hello world 能够简单快速地开始一个新知识的练习。让我们从GitHub开始!

你将学习到:

  • 创建和使用仓库(repository)
  • 开始和管理一个新的分支(branch)
  • 更改文件内容并将更改后的文件按提交的方式推送(push)到GitHub
  • 开始和合并一个pull请求

什么是GitHub?


GitHub是一个用于版本控制和协作的代码托管平台。让你和其他人可以在任何地方共同完成项目。

本教程将向你介绍GitHub的基本要素,如仓库分支提交,和Pull请求。你将创建自己的Hello World仓库,学习GitHub上Pull请求的工作流,一种创建和检查代码的流行方法。

无需编程

要完成本教程,你需要github帐户和网络。你不需要知道如何编写代码、使用命令行或安装Git(版本控制软件GitHub是在此基础上构建的)。

提示:在单独的浏览器窗口(或选项卡)中打开本指南,以便在完成本教程中的步骤时看到它。

 

第一步 创建一个仓库(repository)


一个 仓库 通常用于组织单个项目。仓库可以包含文件夹、文件、图像、视频、电子表格和数据集等项目需要的任何内容。我们建议增加自述,或者包含项目信息的文件。在创建新仓库的同时,GitHub可以轻松地添加一个。它还提供其他常见选项,如许可证文件。

你的 hello-world 仓库可以是你存储想法、资源,甚至与他人共享和讨论事物的地方。

创建一个新仓库

  1. 在右上角,在你的头像旁边,单击 然后选择New repository.
  2. 命名仓库 hello-world
  3. 写一段简短的描述
  4. 选择  Initialize this repository with a README

new-repo-form

点击 Create repository  

 

第二步 创建分支(branch)


分支是同一仓库在同一时间操作不同版本的工作方式。

默认情况下,你的仓库有一个名为 master 被认为是最终的分支。在提交之前,我们使用分支进行实验和编辑。

当你从主分支master创建一个分支时,你是正在对master分支进行复制或快照。如果其他人对master分支进行更改,同时你也正在处理自己的分支时,你可以得到他们的更新。

下图显示:

  • master 分支
  • 一个叫feature 的新分支(因为我们正在这个分支上做“重要工作”)
  • feature 分支在被合并进master主分支前的历程

a branch

你曾经保存过同一文件的不同版本吗?类似于:

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

分支在GitHub仓库中完成了类似的目标。

在GitHub上,我们的开发人员、作者和设计人员使用master以外的分支将漏洞修复和重要工作从主分支中分开。当一个漏洞测试没有问题后就会把分支合并到主分支master中。 

创建一个新分支

  1. 找到刚创建好的新仓库hello-world.
  2. 单击文件列表顶部的下拉列表,显示branch:master
  3. 输入分支名称:readme-edits,转到新的分支文本框中。
  4. 点击蓝色 Create branch 或者在键盘上按下“Enter”键。

branch gif

现在你有两个分支,masterreadme-edits。他们现在看起来完全一样,但不会太久!接下来,我们将修改新的分支readme-edits

 

第三步 完成并提交更改


太棒了!现在,你在readme-edits分支的代码视图中,它是master分支的一个复制版。我们来做些编辑。

在GitHub上,保存的更改叫做提交。每次提交都有一个关联的提交信息,这个提交信息解释了为什么有这些修改。提交消息捕捉了你更改的历史,以便其他贡献者能够了解你所做的事情以及这样做的原因。

完成并提交更改

  1. 点击README.md 文件
  2. 单击在文件视图右上角的铅笔图标进行编辑。
  3. 在编辑中,写一些关于你自己的事情。
  4. 编写一段修改的信息描述修改的内容。
  5. 点击 Commit changes 按钮。

commit

这些修改只针对readme-edits分支的README 文件,所以现在这个分支包含的内容与master分支的内容有区别了.

 

第四步 打开Pull请求


修改得不错!现在,你已经更改了master 主分支上的一个分支(即readme-edits分支),你可以打开一个Pull请求了.

Pull请求是GitHub协作工作的核心。当你打开一个Pull请求,你给出了你为什么修改的提议,并且希望别人能够针对你的修改作出回复,同步你修改或新增的代码,能够把这些代码合并到他们的分支中。Pull请求能够显示差异,以及来自两个分支的内容上的不同。修改和新增的代码用绿色标出,删除的代码用红色标出。

一旦提交,就可以打开Pull请求并且开始讨论,直到在代码完成之前(合并到master中,或者最终没有被采纳)。

通过使用GitHub在你的Pull request消息的@mention system,你可以向特定的人或团队征求反馈,不管他们是在大厅下面,还是在10个时区之外。

你甚至可以在自己的仓库中打开Pull请求,自己合并它们。在开始大型项目之前,这是了解GitHub工作流的一个很好的方法。

为修改的README打开一个Pull请求

单击图像以获得更大的图片

步骤 截图
单击 Pull requests 选项,进入“Pull request”页面,点击绿色 New pull request 按钮。 pr-tab
Example Comparisons框中,选择你创建的分支readme-edits,与master(原始分支) 进行比较。 branch
检查并比较你的修改与页面上的差异,确保这些修改是你想要提交的。 diff
当你满意这些想提交的修改时,点击大的绿色 Create pull request 按钮。 create-pull
给你的pull请求写一个标题和一个简短的描述你的修改。

pr-form

当你完成了这些内容后,单击 Create pull request!

提示:你可以用表情符号也可以把图像和gifs动画拖放到评论和pull请求上面。

 

第五步 合并你的Pull请求


在最后一步中,是时候将你的修改合并在一起了-将你的readme-edits分支合并到master主分支。

  1. 单击绿色 Merge pull request 按钮将修改合并到master分支.
  2. 点击 Confirm merge.
  3. 去前一页删除分支,如果修改已被合并到master, Delete branch 按钮会在紫色框中显示。

mergedelete

祝贺!

通过完成本教程,你已经学会了在GitHub上创建一个项目并发出pull请求!  

下面是你在本教程中完成的工作:

  • 创建了一个开放源码仓库
  • 开始管理一个新分支
  • 修改文件并将这些修改提交给GitHub
  • 打开合并一个pull请求

看看你的GitHub简介,你会看到你的新的贡献!

要了解更多关于pull请求的功能,我们建议阅读GitHub工作流指南。你也可以访问GitHub探索并参与开源项目


提示:看看我们的另一个指南, YouTube频道和On-Demand Training有关如何开始使用GitHub的更多信息。

 

你可能感兴趣的:(github官方新手指南—Hello World)