git与github——5，GitHub Guides 教程

迷南。 2022-04-04 05:18 227阅读 0赞

貌似现在看一本书谈到coder都会说到github，不会用github给人感觉都比较菜~~

原来也只会clone、pull之类的，要如何用github来提升代码水平？而且公司转型的发展方向也是想多用开源软件，如何使用开源软件提升开发效率、完善功能？当然开源软件，毕竟和商用软件不同，它的bug、运维、不足之处该如何处理？

带着这几个问题来啃一啃github这个网站。

# 一、开启github之旅 #

话不多说，github注册之类很简单，用邮箱注册就行，博主用qq邮箱之前就注册过了。

在自己的repository（仓库），有个教程：

## 1，guide说明 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70][]

Learn Git and GitHub without any code!

不用代码就可以学git和github了！

Using the Hello World guide, you’ll create a repository, start a branch, write comments, and open a pull request.

老规矩，撸代码从HelloWorld开始，这个教程会新建一个分支，写一些说明，让后开启一个pull request ，pull是拉的意思，这个pull request 还真不好翻译，感觉就是拉了代码还不算，要告诉源头你不仅拉了下来还想改源代码。

比较官方的解释："Pull Request 是一种通知机制。你修改了他人的代码，将你的修改通知原来的作者，希望他合并你的修改，这就是 Pull Request。"

## 2，Hello world项目 ##

这是个10分钟阅读完的guide，但是英文读的少的人，估计要苦哈哈的慢慢读吧，哈哈。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 1][]

界面还不错

The **Hello World** project is a time-honored tradition in computer programming. It is a simple exercise that gets you started when learning something new. Let’s get started with GitHub!

这个hello world项目是变成里历史悠久的项目（最能代表程序员的内容：Hello world、找不到对象、格子衫），它在你开始学习新的东西是很舒服的简单练习，开始撸github吧！

**You’ll learn how to:**

*  Create and use a repository
 *  Start and manage a new branch
 *  Make changes to a file and push them to GitHub as commits
 *  Open and merge a pull request

能够学到的：

*  创建和使用repository
 *  开启和管理新的分支
 *  改变文件然后将他们当作提交内容给github
 *  打开和合并一个pull request

**What is GitHub?**

**啥是github？**

GitHub is a code hosting platform for version control and collaboration. It lets you and others work together on projects from anywhere.

github 是一个用作版本管理和协作开发的代码托管平台（也是全球最大搞基平台）。它能连接各个地方的码农。

This tutorial teaches you GitHub essentials like *repositories*, *branches*, *commits*, and *Pull Requests*. You’ll create your own Hello World repository and learn GitHub’s Pull Request workflow, a popular way to create and review code.

这个小教程会教你一些github的核心要素，像 repositories、branches、commits和pull requests. 你可以创建一个你自己的hello world 仓库然后学习github的pull request工作流，这个方法创建和检查代码是很流行的哦。

No coding necessary

不用写代码

To complete this tutorial, you need a [GitHub.com account][] and Internet access. You don’t need to know how to code, use the command line, or install Git (the version control software GitHub is built on).

要完成这个教程，你需要一个github账号（很好申请的，邮箱注册就好）而且能联网。你不需要知道怎么撸代码（当然不知道撸代码的一般也不会知道github），用命令行，或者装一个git（基于这个版本控制软件github才能建立，话说git也是开发linux的那个大佬，名字叫Linus Torvalds，嘿嘿是不是很好记，总之外国人的x和s差不了太多，想了解linux的故事，来看看我的博客[https://blog.csdn.net/qq\_22059611/article/details/82939714][https_blog.csdn.net_qq_22059611_article_details_82939714]）

**Tip:** Open this guide in a separate browser window (or tab) so you can see it while you complete the steps in the tutorial.

建议：把这份知道放在一个单独的浏览器窗口（或者标签，tab就是标签咯），这样你就可以边完成教程里的步骤，边看着。（当然，大家都是老鸟，不分开打开时看不下去的）

## Step 1. Create a Repository ##

第一步，创建repository

A **repository** is usually used to organize a single project. Repositories can contain folders and files, images, videos, spreadsheets, and data sets – anything your project needs. We recommend including a *README*, or a file with information about your project. GitHub makes it easy to add one at the same time you create your new repository. *It also offers other common options such as a license file.*

一个仓库通常都用来阻止一个单独的项目。仓库可以包含文件夹和文件、图片、视频、电子表格和数据集——你工程所需的一切（博主之前把说明word、图片各种东东都放进去了，发现还是放文本类的东东比较好，原来还想把它当网盘用，放多了点东西，发现，真的好慢啊！）。我们推荐你家一个readme之类的文件（一般这个文件用.md），或者一个能介绍项目相关信息的文件。github让你创建新仓库的时候添加一个说明文件变得简单。它也给你提供了一些像许可证文件之类的公共选项。

Your `hello-world` repository can be a place where you store ideas, resources, or even share and discuss things with others.

你的hello-world仓库可以作为一个保存你想法、资源甚至和别人分享讨论事情的地方！（我看了有些repository放了很多资料，棒棒的！）

### To create a new repository ###

创建一个新仓库

1.  In the upper right corner, next to your avatar or identicon, click  and then select **New repository**.
2.  Name your repository `hello-world`.
3.  Write a short description.
4.  Select **Initialize this repository with a README**.

1.  在右上角，你的头像或者缩略图旁，点击然后选择新建repository
2.  给你仓库取名hello-world
3.  写一个简要的说明
4.  选择用一个readme文件来初始化这个仓库

大体面说的就是这几步：

（1）记得这个+号咯，新建的东东都在这

![20181217232202590.png][]

（2）这样都填完了的话就不用担心后面老让你填readme文件了，可以说最快速的创建方式，所以嘛多看看官方文档，比自己瞎折腾要有效率。hello-world1的名字，是因为hello-world已经建过了，所以只好加个1。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 2][]

官网的图片：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 3][]

Click **Create repository**. ![:tada:][tada]

最后点击那个绿色的图标就可以创建了！

## Step 2. Create a Branch ##

## 步骤2，创建一个分支 ##

**Branching** is the way to work on different versions of a repository at one time.

分支（为啥这里是ing）是一种同时在仓库的不同版本间工作的方式。（官方解释哦，个人感觉版本管理最好用的就是保存版本的日志，用来做回退，另一个就是分支，各干个的到时候合在一起就行了）

By default your repository has one branch named `master` which is considered to be the definitive branch. We use branches to experiment and make edits before committing them to `master`.

仓库有个默认分支master，它被视作主分支（毕竟master嘛）。我们可以用其他分支来做做实验，写些修改，然后再提交给master。

When you create a branch off the `master` branch, you’re making a copy, or snapshot, of `master` as it was at that point in time. If someone else made changes to the `master` branch while you were working on your branch, you could pull in those updates.

当你从主分支中（master分支）创建一个新的分支，相当于你做了master这个时间点的一份拷贝，或者叫快照（没错，就是maven中一创建就设定的版本，其实英文就那么几个单词，像const和final之类的含义差不多，就是写法不一样）。当你在你的分支上撸代码，其他人给master分支提交了一些代码，你可以拉下（pull in）这些更新。

This diagram shows:

下面这个图表（diagram我感觉一般指有数字或者分解步骤之类的图，解释性的图吧）演示了：

*  The `master` branch
 *  A new branch called `feature` (because we’re doing ‘feature work’ on this branch)
 *  The journey that `feature` takes before it’s merged into `master`

*  master分支
 *  一个叫feature的分支（因为我们是在做分支上做‘功能性的工作’）（博主原来很好奇为啥老要用feature做分支的代名词，什么鬼feature-a，feature-b之类的，明明这是特色的意思啊！其实嘛翻译成功能就好理解了，你要加啥功能就是个什么样的分支咯）
 *  功能分支被合并到master分支经历的过程（journey 是旅程的意思，这个词能衍生出贼多的词，像报纸journal，总之要么是自己动，要么是其他人动，获取的经历）

![a branch][]

Have you ever saved different versions of a file? Something like:

你之前有木有保存过一个文件的不同版本？（当然有啊！我喜欢加日期）像这样的：

*  `story.txt`
 *  `story-joe-edit.txt`
 *  `story-joe-edit-reviewed.txt`

Branches accomplish similar goals in GitHub repositories.

分支在github的仓库里做的事情差不多。

Here at GitHub, our developers, writers, and designers use branches for keeping bug fixes and feature work separate from our `master` (production) branch. When a change is ready, they merge their branch into `master`.

在github，我们的攻城狮、写手安定设计狮用分支来debug，用功能性的分支独立于master分支开发。当一个改变成熟了，就重新合并到master分支。

### To create a new branch ###

新建一个分支

1.  Go to your new repository `hello-world`.
2.  Click the drop down at the top of the file list that says **branch: master**.
3.  Type a branch name, `readme-edits`, into the new branch text box.
4.  Select the blue **Create branch** box or hit “Enter” on your keyboard.

1.  来到你新建的hello-world 仓库
2.  单击下来列表，显示的branch:master这一项
3.  敲一个分支名 `readme-edits`,到新建分支的文本框.
4.  选择蓝色的 **Create branch** 盒子或者敲enter键.

图如下所示

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 4][]

这样子，以后就有两个分支了：

![20181218162213853.png][]

github有动图：

![branch gif][]

Now you have two branches, `master` and `readme-edits`. They look exactly the same, but not for long! Next we’ll add our changes to the new branch.

现在你有两个分支了：master和`readme-edits。他们看起来一模一样，但以后就就不是了！然后我们要给新分支加点变化。`

Step 3. Make and commit changes

步骤3  改变项目并提交

Bravo! Now, you’re on the code view for your `readme-edits` branch, which is a copy of `master`. Let’s make some edits.

哇！现在，你是在`readme-edits`分支的代码模式，这是master分支的一份拷贝。让我们做些编辑。

On GitHub, saved changes are called *commits*. Each commit has an associated *commit message*, which is a description explaining why a particular change was made. Commit messages capture the history of your changes, so other contributors can understand what you’ve done and why.

在github，被保存的改变被叫做commits。每一个commit有一个相联系的commit消息，这个消息可以解释为啥要提交。提交信息捕获了你撸代码变化的历史，所以别的代码贡献者可以理解你做了什么和为什么这么做。

Make and commit changes

做和提交更改

1.  Click the `README.md` file.
2.  Click the  pencil icon in the upper right corner of the file view to edit.
3.  In the editor, write a bit about yourself.
4.  Write a commit message that describes your changes.
5.  Click **Commit changes** button.

1.  单击 `README.md` 文件
2.  单击右上角的铅笔图表，来进行浏览和编辑.
3.  在编辑器，写一点关于你自己的东东.
4.  写一个更改信息，来描述你的更改.
5.  单击 **Commit changes** 按钮.

![commit][]

These changes will be made to just the README file on your `readme-edits`branch, so now this branch contains content that’s different from `master`.

这些更改只会写入到你的`readme-edits`分支的Reademe文件，所以现在你的分支包含了不同于master的内容。

## Step 4. Open a Pull Request ##

步骤4，打开一个pull reqeust

Nice edits! Now that you have changes in a branch off of `master`, you can open a *pull request*.

棒棒的！现在你有一个和master不一样的分支了，可以来玩一玩pull request了。

Pull Requests are the heart of collaboration on GitHub. When you open a *pull request*, you’re proposing your changes and requesting that someone review and pull in your contribution and merge them into their branch. Pull requests show *diffs*, or differences, of the content from both branches. The changes, additions, and subtractions are shown in green and red.

Pull Requests是github合作开发的核心！当你开启了一个pull request，你提议提交你的更改并让人来复核，之后将你的贡献加入到他们的分支中（这就是pull request的意思咯，就是请求原作者拉近他们的分支）。pull request显示了diffs或者叫差异，这个差异指的是不通分支内容的差异。这些变化、新增的内容和减少的内容展示成绿的或者红的。

As soon as you make a commit, you can open a pull request and start a discussion, even before the code is finished.

当你做出了一个commit，你可以打开一个pull request 并开启一个讨论，当然可以是在代码完成前的咯。

By using GitHub’s [@mention system][mention system] in your pull request message, you can ask for feedback from specific people or teams, whether they’re down the hall or 10 time zones away.

通过在你的pull request消息中使用GitHub的[@mention system][mention system] ，你可以向特定的人群或者团队获取反馈，不管他们就在走廊或者离你10个时区远。

You can even open pull requests in your own repository and merge them yourself. It’s a great way to learn the GitHub flow before working on larger projects.

你甚至可以在你自己的仓库发起pull requests 然后亲手合并他们。这个东东用来学习github工作流贼方便！

Open a Pull Request for changes to the README

给README文件的修改发起pull request

*Click on the image for a larger version*

点击图片可以看到更大图片的版本哦

<table> 
 <thead> 
 <tr> 
 <th> Step 步骤 </th> 
 <th> Screenshot 截图 </th> 
 </tr> 
 </thead> 
 <tbody> 
 <tr> 
 <td> Click the&nbsp;&nbsp;Pull Request&nbsp;tab, then from the Pull Request page, click the green&nbsp;New pull request&nbsp;button. 点击pull request的选项卡，然后从pull request页面，单击绿色的 New pull request 按钮 </td> 
 <td><a href="https://guides.github.com/activities/hello-world/pr-tab.gif" rel="nofollow"><img alt="pr-tab" src="https://guides.github.com/activities/hello-world/pr-tab.gif"></a></td> 
 </tr> 
 <tr> 
 <td> In the&nbsp;Example Comparisons&nbsp;box, select the branch you made,&nbsp;<code>readme-edits</code>, to compare with&nbsp;<code>master</code>&nbsp;(the original). 在Example Comparisons盒子里，选择你写的<code>readme-edits</code>&nbsp;分支，和<code>master</code>分支进行比较（原始的） </td> 
 <td><a href="https://guides.github.com/activities/hello-world/pick-branch.png" rel="nofollow"><img alt="branch" src="https://guides.github.com/activities/hello-world/pick-branch.png"></a></td> 
 </tr> 
 <tr> 
 <td> Look over your changes in the diffs on the Compare page, make sure they’re what you want to submit. 查看Compare page中diffs中的变化，确保你知道他们是你想提交的东东。 </td> 
 <td><a href="https://guides.github.com/activities/hello-world/diff.png" rel="nofollow"><img alt="diff" src="https://guides.github.com/activities/hello-world/diff.png"></a></td> 
 </tr> 
 <tr> 
 <td> When you’re satisfied that these are the changes you want to submit, click the big green&nbsp;Create Pull Request&nbsp;button. 当你同意这些东邪是你想提交的，单击绿色的Create Pull Request按钮 </td> 
 <td><a href="https://guides.github.com/activities/hello-world/create-pr.png" rel="nofollow"><img alt="create-pull" src="https://guides.github.com/activities/hello-world/create-pr.png"></a></td> 
 </tr> 
 <tr> 
 <td> Give your pull request a title and write a brief description of your changes. 给你的pull request一个标题，然后给你的变更写一个简介 </td> 
 <td><a href="https://guides.github.com/activities/hello-world/pr-form.png" rel="nofollow"><img alt="pr-form" src="https://guides.github.com/activities/hello-world/pr-form.png"></a></td> 
 </tr> 
 </tbody> 
</table>

When you’re done with your message, click **Create pull request**!

当你写完了你的消息，单击 **Create pull request**!

--------------------

> **Tip**: You can use [emoji][] and [drag and drop images and gifs][] onto comments and Pull Requests.

建议：你可以在pull requests和平路用 [emoji][] （表情之类的吧）和可拖放图片

## Step 5. Merge your Pull Request ##

步骤5，合并你的pull request

In this final step, it’s time to bring your changes together – merging your `readme-edits` branch into the `master` branch.

1.  Click the green **Merge pull request** button to merge the changes into `master`.
2.  Click **Confirm merge**.
3.  Go ahead and delete the branch, since its changes have been incorporated, with the **Delete branch** button in the purple box.

在这最后的步骤，是该把你的更改弄在一起了——合并你的`readme-edits`分支到 `master` 分支。

1.  单击绿色的 **Merge pull request** 按钮来把变化合并到 `master`中
2.  单击 **Confirm merge**.
3.  继续然后删掉这个分支, 由于它的更改都被合并, 这个 **Delete branch** 按钮会出现在辞色的盒子里.

![merge][]

![delete][]

### Celebrate! ###

恭喜！

By completing this tutorial, you’ve learned to create a project and make a pull request on GitHub! ![:tada:][tada 1] ![:octocat:][octocat] ![:zap:][zap]

通过完成这个教程，你学会了如何去创建项目和在github中发起一个pull request。

Here’s what you accomplished in this tutorial:

这是你在教程中完成的内容：

*  Created an open source repository
 *  Started and managed a new branch
 *  Changed a file and committed those changes to GitHub
 *  Opened and merged a Pull Request

*  创建并打开资源（代码）仓库
 *  开启并合并一个新的分支
 *  更改一个文件然后将这些变动提交给github
 *  打开和合并一个pull request

Take a look at your GitHub profile and you’ll see your new [contribution squares][]!

看一看你的Github 配置文件，你会看到你新的贡献广场（[contribution squares][]）。

To learn more about the power of Pull Requests, we recommend reading the [GitHub flow Guide][]. You might also visit [GitHub Explore][] and get involved in an Open Source project ![:octocat:][octocat]

想了解更多的pull requests所具备的能力，我们推荐你阅读 [GitHub flow Guide][].你也可能想看看[GitHub Explore][]参与到开源项目中来！

--------------------

> **Tip**: Check out our other [Guides][], [YouTube Channel][] and [On-Demand Training][] for more on how to get started with GitHub.

建议：检查一些我们 [Guides][], [YouTube Channel][]和[On-Demand Training][] 可以获取更多关于如何开启github的知识

Last updated April 7, 2016

上次更新：2016年4月7日。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70]: /images/20220404/e042948a0dca4c8d87429cee4aca3465.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 1]: /images/20220404/697516527336416583761f68380aab95.png
[GitHub.com account]: http://github.com/
[https_blog.csdn.net_qq_22059611_article_details_82939714]: https://blog.csdn.net/qq_22059611/article/details/82939714
[20181217232202590.png]: /images/20220404/abb7aa27ff1e425386d542b60edf321d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 2]: /images/20220404/d0a567a5b7bc4ca8a65e855f4eb9322a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 3]: /images/20220404/2e0d4c59adef46d29f61a4a9fd54af7a.png
[tada]: /images/20220404/2edd8208e6444d19b106a671dafaf1f1.png
[a branch]: /images/20220404/4fa6a9a6c7da466abd2c59cc333da5e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIyMDU5NjEx_size_16_color_FFFFFF_t_70 4]: /images/20220404/19115472542d4da0ac933c1c1bb4a08d.png
[20181218162213853.png]: /images/20220404/e8fbf36bdf66426186737ca98ba282d9.png
[branch gif]: /images/20220404/66dde70b44274a5b873d11152770db3d.png
[commit]: /images/20220404/b27f11b9615c49a2beb80aa8f644cce6.png
[mention system]: https://help.github.com/articles/about-writing-and-formatting-on-github/#text-formatting-toolbar
[emoji]: https://help.github.com/articles/basic-writing-and-formatting-syntax/#using-emoji
[drag and drop images and gifs]: https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/
[merge]: /images/20220404/3565632445e5443a9d887cc5cd799bd7.png
[delete]: /images/20220404/532ce97d603b47babd5c8238e0a8628c.png
[tada 1]: https://assets-cdn.github.com/images/icons/emoji/unicode/1f389.png
[octocat]: https://img-blog.csdnimg.cn/20181219100537936
[zap]: /images/20220404/4708f516e23b4507b36c33e1ae731022.png
[contribution squares]: https://help.github.com/articles/viewing-contributions
[GitHub flow Guide]: http://guides.github.com/overviews/flow/
[GitHub Explore]: http://github.com/explore
[Guides]: http://guides.github.com/
[YouTube Channel]: http://youtube.com/githubguides
[On-Demand Training]: https://services.github.com/on-demand/