GitHub官方入门文档

末蓝、 2022-07-12 02:56 126阅读 0赞

原文地址（翻译于2017/2/7）：[https://guides.github.com/activities/hello-world/][https_guides.github.com_activities_hello-world]

# GitHub官方入门文档 #

“HelloWorld”项目是计算机编程领域一个历经时间考验的传统项目。当你在接触某样新事物的时候，“HelloWorld”项目往往会成为你第一个接触的小练习。让我们就用一个“HelloWorld”项目为例，来开启我们的GitHub之旅！

#### 你需要学习以下内容： ####

*  新建一个仓库，并学习使用他
 *  新建一个分支，并学习管理他
 *  对一个文件进行修改，并学习将这个修改作为一个提交（commits）推送（push）到你的github仓库
 *  新建一个请求合并（pull request）

## 什么是GitHub？ ##

Github是一个可以进行版本控制和开发写作的代码托管平台。他可以使你和你的同事能够在任何地方协作开发。  
本教程将教你使用github的重要功能，比如仓库（repositories）、分支（branches）、提交（commits）以及请求合并（pull requests）。你将创建你自己的“Hello World”仓库，并学习一个广受欢迎的代码构建/审查方式：在github上进行请求合并（pull request）的流程。

### 不需要任何代码 ###

为了完成本教学，你至少得拥有上网能力，并拥有一个github账号。你不必知道如何编码，也不用知道如何操作命令行，也不用安装“Git”（github正是构建在这个版本控制软件之上）。

> 提示：建议你将本教程在一个新的浏览器或标签页打开，这样你就可以同时看到教程并完成一步步的操作。

## 第一步：创建仓库 ##

一个仓库通常用来管理一个项目。仓库能存储文件夹、文件、图片、视频、电子数据表以及数据集合—任何你需要的项目。我们建议每个仓库包含一份“README”文件，或者一个关于你项目的信息文件。Github会在你生成新仓库时非常容易的创建这个信息文件。同时Github也提供其他许多公共选项，比如版权声明文件。  
你的hello-world仓库可以是你存储你的想法、资源、甚至是与他人讨论分享的一个场所。

### 创建一个新的仓库 ###

1.在页面右上角你个人头像旁边，单击“+”按钮然后选择“New repository”选项。  
2.命名你的仓库为“hello-world”。  
3.为你的仓库写一个简短的描述。  
4.选中“Initialize this repository with a README”栏。  
![这里写图片描述][SouthEast]  
5.点击“Create repository”按钮。

## 第二步：创建一个分支 ##

操作分支（branching）正是我们在同一时刻能对不同版本进行工作的基础。  
默认情况下你的仓库将会拥有一个名为“master”的分支，该分支也通常就是项目的主要分支。我们会使用其他分支在将提交合并到“master”分之前来试验并编辑项目。  
当你从“master”分支创建一个新的分支时，你实际上执行了一次复制操作，或称之为“快照”（即“master”分支在当前时刻节点的一份快照）。以后，当你在操作其他分支时，有人修改了“master”分支，你可以通过拉取（pull）来获得那些更新。  
以下图表展示了：

*  master分支
 *  一个叫做feature的新分支（feature意为特性，我们正好起了这个名字）
 *  在合并到master分支前，feature分支的日志流程  
    ![这里写图片描述][SouthEast 1]  
    你曾经有不有尝试过保存不同版本的文件（在其他版本管理工具上）？例如：
 *  story.txt
 *  story-joe-edit.txt
 *  story-joe-edit-reviewed.txt  
    分支功能就为github仓库提供了这样保存不同版本文件的能力。  
    在github，几乎所有的开发者、作家、设计者使用分支来修复缺陷并创建新特性，而不是直接在master分支（master分支往往是生产环境）上进行这些修改。当完成了一个修改后，他们才将那些特性分支合并到master分支。

### 让我们创建一个新的分支 ###

1.进入你的仓库：hello-world。  
2.单击文件列表顶部的分支按钮“master”，出现一个下拉列表。  
3.在新分支名输入框中输入一个分支名称，readme-edits  
4.单击蓝色的“Create branch”按钮或者按下你键盘上的“回车”键。  
（原文中这幅图是一个gif动图，读者可以在文章开头找到原文地址来查看）  
![这里写图片描述][SouthEast 2]  
现在你就拥有两个分支了，分别是master分支和readme-edits分支。他们看上去是一样的，但是不就之后就会有变化！接下来让我们向新建的分支中加入修改。

## 第三步：创建并提交修改 ##

恭喜！现在你拥有了一个从master分支复制而来的readme-edits分支，让我们来对他做一些修改。  
在github上，被保存下的修改被称为一个“提交”（commits）。每一个提交会附带一个提交信息，这个提交信息会说明本次修改包含了什么内容。提交信息会出现在历史记录中，这样其他项目合作者就可以通过查看提交信息来理解你的修改。

### 创建并提交修改 ###

1.单击README.md文件。  
2.单击文件视图界面右上角的![这里写图片描述][SouthEast 3]铅笔图标来编辑当前文件。  
3.在编辑器中，写下关于你的一些内容。  
4.写下一个提交信息（commit message）。  
5.单击“Commit changes”按钮。  
![这里写图片描述][SouthEast 4]  
以上这些修改将会引起readme-edits分支上的“README”文件变化，因此现在这个分支就包含了与master分支不同的内容。

## 第四步：创建一个请求合并（pull request） ##

完成上面的修改，你现在拥有一个与master分支有区别的分支，你就可以开启一次请求合并（pull request）。  
请求合并（pull request）是github上协作的核心功能。当你开启了一个请求合并，你就相当于向某人发起提交请求，以期对方在检查你的修改后将其合并到对方的分支中。请求合并会展示两个分支中的不同之处。任何修改、添加以及删除都会被标记位绿色和红色。  
一旦你完成了一个提交（commit），你就能创建一个请求合并，这会开启一个会话讨论。这个会话讨论甚至可以在代码完成之前开启（往往能提高效率）。  
通过在请求合并信息中使用github的@系统，你可以向特定的人或团队询问修改反馈，不论那些被你@的人离你多远。  
你也可以在你自己的仓库内创建请求合并，并将他们合并起来。在你着手一个大型项目之前，你最好通过这种方式来提前了解一下github的工作模式。

### 为README文件的修改创建一个请求合并（pull request） ###

你可以通过点击图片来查看大图。  
注意：请通过文章顶部的原文链接来查看图片，本文为翻译，不提供图片点击功能。

<table> 
 <thead> 
  <tr> 
   <th>步骤</th> 
   <th align="center">截图</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>单击<img src="https://img-blog.csdn.net/20170208141117582?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveXVoazIzMQ==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast" alt="这里写图片描述">“Pull Request”标签，在请求合并页面，单击绿色的“New pull request”按钮</td> 
   <td align="center"><img src="https://img-blog.csdn.net/20170208140657031?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveXVoazIzMQ==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast" alt="这里写图片描述"></td> 
  </tr> 
  <tr> 
   <td>选中你操作的分支，readme-edits，来和master分支（源分支）进行比对。</td> 
   <td align="center"><img src="https://img-blog.csdn.net/20170208140733032?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveXVoazIzMQ==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast" alt="这里写图片描述"></td> 
  </tr> 
  <tr> 
   <td>仔细检查在比对页区别项中的修改，确保所有的区别正是你想要提交的修改。</td> 
   <td align="center"><img src="https://img-blog.csdn.net/20170208140803237?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveXVoazIzMQ==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast" alt="这里写图片描述"></td> 
  </tr> 
  <tr> 
   <td>当你比对满意后，单击大大的绿色按钮“Create Pull Request”。</td> 
   <td align="center"><img src="https://img-blog.csdn.net/20170208140916050?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveXVoazIzMQ==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast" alt="这里写图片描述"></td> 
  </tr> 
  <tr> 
   <td>给你的请求合并起一个标题（title），并为你的修改写一个简短的说明。</td> 
   <td align="center"><img src="https://img-blog.csdn.net/20170208140945847?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQveXVoazIzMQ==/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/SouthEast" alt="这里写图片描述"></td> 
  </tr> 
 </tbody> 
</table>

当你完成信息填写后，单击“Create pull request”按钮！

> 提示：你可以在请求合并以及评论区使用表情包以及各种动图。

## 第五步：合并向你发出的请求合并（pull request） ##

在这最后一步，是时候来完成你的修改—将readme-edits分支合并到master分支。  
1.单击绿色的“Merge pull request”按钮，来将修改合并到master分支。  
2.单击“Confirm merge”。  
3.因为我们的修改已经被包含在主分支中，因此我们可以通过点击紫色的“Delete branch”按钮来删除特性分支。  
![这里写图片描述][SouthEast 5]

### 恭喜！ ###

通过完成本教程，你已经学会了如何在github上创建一个项目并开启一个请求合并！  
以下列出了你在本教程中完成的项目：

*  创建并开启一个资源仓库（repository）
 *  创建并管理一个新的分支（branch）
 *  修改一个文件，并将这些修改提交（commit）至github
 *  创建并合并一次请求合并（pull request）  
    看一看你的github个人页面，你将会看到新的贡献块（contribution squares）！如果想要学习更多请求合并（pull request）的威力，我们建议你阅读“GitHub Flow Guide”（github流程教程：[https://guides.github.com/introduction/flow/）。你也可以通过浏览“GitHub][https_guides.github.com_introduction_flow_GitHub] Explore”（github浏览页：[https://github.com/explore）来参与任何一个开源项目。][https_github.com_explore]

[熬夜不易，请作者喝酒！][Link 1]

[https_guides.github.com_activities_hello-world]: https://guides.github.com/activities/hello-world/
[SouthEast]: /images/20220711/560e8bb433c84f128492f175420b47ea.png
[SouthEast 1]: /images/20220711/4661ced5ab044901b812fd6c03105582.png
[SouthEast 2]: /images/20220711/12faa0a1f96c4706a0adde3b811c43aa.png
[SouthEast 3]: /images/20220711/0e8ffc2c643b43c4a981feb2a4da6023.png
[SouthEast 4]: /images/20220711/de2ad56c3d944d0ab2f3fc6a3351abcb.png
[SouthEast 5]: /images/20220711/56381c0bf2da4f3599763a0ece59d2ad.png
[https_guides.github.com_introduction_flow_GitHub]: https://guides.github.com/introduction/flow/%EF%BC%89%E3%80%82%E4%BD%A0%E4%B9%9F%E5%8F%AF%E4%BB%A5%E9%80%9A%E8%BF%87%E6%B5%8F%E8%A7%88%E2%80%9CGitHub
[https_github.com_explore]: https://github.com/explore%EF%BC%89%E6%9D%A5%E5%8F%82%E4%B8%8E%E4%BB%BB%E4%BD%95%E4%B8%80%E4%B8%AA%E5%BC%80%E6%BA%90%E9%A1%B9%E7%9B%AE%E3%80%82
[Link 1]: https://raw.githubusercontent.com/bigbird231/iTest/master/imgs/drink.png