什么是 GitHub?
GitHub 是一个用于版本控制和协作的代码托管平台。实现不同的人随时随地共同处理项目。
GitHub 官网使用指南
指南地址:[GitHub官网指南](https://guides.github.com/activities/hello-world/)
通过本文,您将会学到以下内容:
- 如何注册GitHub账号
- 如何创建和使用仓库
- 如何创建和管理分支
- 如何创建一个文件
- 如何改变一个文件并将它提交到GitHub上
- 如何发起以及合并请求
- 如何利用GitHub平台进行交流
tips:使用单独的浏览器窗口中打开本指南,方便对照本教程在guihub进行练习
一、注册GitHub账号
【1】登录GitHub网站
GitHub网址:https://github.com/
【2】注册流程
点击右上角【sign up】注册新账号,举例如下:
1、填写用户名(Username)、邮箱(Email address)、密码(Password)
2、进行邮箱验证(Email preferences)
3、进行人为操作的验证(Verify your account)
【具体细节根据网页提示进行操作】
【3】登录账户
账号创建成功后, 点击右上角sign in登录账号,出现如下页面后填写相关信息点击Sign in登录
登录后主页界面
二、创建一个新的仓库New repository
一个仓库通常用来组织一个单独的项目。仓库来存储你的想法、资源,甚至用它来和别人分享、讨论任何事情。该仓库可以包含你项目中的所有文件,如文件夹、文件、图片、视频、电子表格、数据集等。建议包含一个README文件,或者你自定义的用来记录项目信息的文件。GitHub将默认在你创建仓库的时候添加它。在创建的同时还提供了权限许可选项。
具体操作步骤如下:
1、在页面的最右上角,你的头像的左边,点击“+”,在弹出的下拉选项中选择“New repository”。
2、根据页面提示创建repository
Repository name: 仓库名称
Description(可选): 仓库描述介绍
Public, Private: 仓库权限(公开共享,私有或指定合作者)
Initialize this repository with a README: 初始化文件 README.md
gitignore: 不需要进行版本管理的仓库类型,对应生成文件 .gitignore
license: 证书类型,对应生成文件 LICENSE
如果创建时,勾选了 Initialize this repository with a README ,则会自动生成一个 README.md 文件;如果选择了 Add .gitignore ,则会自动生成 .gitignore 文件;如果选择 Add a license ,则会自动生成一个 LICENSE 文件。
3、点击页面下方“Create repository”按钮,创建完成,后出现如下页面:
三、创建一个分支
分支是一个可以让你在同一时间工作在同一个仓库的不同版本的方法。
在你的仓库中会有一个默认的名叫“master”的主分支,该分支用来存储你最终确定的版本代码。我们用其他的子分支来进行编辑和更改,确定之后再提交到主分支。
当你从主分支创建出一个子分支的那一刻,其实你就是对当时时间点的主分支做了一个拷贝。如果之后别的分支的人对主分支做出了更新,在你提交到主分支之前,你必须先从主分支上拉取那些更新。
下图显示分支合作的整个流程:
- 主分支
- 一个新的命名为“feature”的子分支(因为我们正在这个分支上做开发)
- “feature”分支合并到主分支之前的历程
新建一个子分支具体操作步骤: - 进入你刚创建的仓库(我刚才创建的是“python-pyecharts”)
- 点击文件列表上方的写着“branch: master”的下拉框
- 在输入框中输入新的分支名字“readme-edits” 点击下方蓝色背景的分支创建框或直接按键盘的“Enter”键
现在,已经有了“master”和“readme-edits”两个分支了。
四、创建一个新文件
点击页面中“Creat new file”按钮
输入想要提交的代码以及下方的文件名和描述后,点击最下方的Commit new file即可。
五、做出修改并提交
在GitHub中,保存更改被称为“提交”。
每一次提交都需要写一段我们为什么做出修改的备注说明。这些备注说明将对你的更改做出记录,其他伙伴看到之后就知道你每次都提交了什么。
现在,我们对新分支“readme-edits”进行修改。
做出修改并提交的步骤如下:
- 点击“README.md”文件,切换
- 到“README.md”内容页面
- 点击编辑框右上角的铅笔按钮,进入编辑界面 在编辑框中,写一些你自己的信息
- 在下方的“提交更改”框中,输入你做出此次修改的备注说明
- 点击下方的“Commit changes”按钮
这些更改只是针对于位于你的“readme-edits”子分支中的 “README.md ”文件,所以现在这个分支上包含的内容和主分支上已经有所不同。
六、发出“请求代码合并”请求
现在你已经对你的新分支做出了修改,我们可以发出“请求代码合并”的请求啦。
请求代码合并是GitHub团队协作的核心功能。
当你发出一个“请求代码合并”请求的时候,相当于你请求别人拷贝你当前的代码做出审查,审查通过之后将你的代码下载并且合并到他们的分支上。该请求将会在所有的分支上显示出不相同的部分。你做出的任何更改、增加以及减少,都会用绿色和红色显示出来。
在你的代码完成之前,你可以随时进行代码提交,发起请求代码合并的请求以及进行一场讨论。
你可以通过GitHub的“@”功能,在每次发出“请求代码合并”请求的时候,向特定的人或团队做出反馈。
你可以向自己的仓库发出“请求代码合并”的请求,并且自己去合并他们。这在你接触到大型项目之前是一个非常好的练习方法。
为更改的README文件发出“请求代码合并”请求:
第一步:点击“Pull Request”选项卡按钮,切换到请求代码合并页面,点击绿色的“New pull request”按钮
第二步:选择你创建的“readme-edits”分支,与主分支进行比较。
第三步:在对比页面查看这些更改,确定他们就是你想要提交的。
第四步:当你确定这些更改就是你所要的时候,点击绿色的“Create Pull Request”按钮。
第五步:为你的更改做一个简单的标题和描述。
当你写完备注描述之后,点击“Create pull request”按钮。
提示:你可以使用emoji表情或者拖拽图片到评论窗口进行评论。
第六步:合并你的“请求代码合并”请求
这是整个过程的最后一步,是时候将你在子分支“readme-edits”做出的更改合并到主分支“master”上了。
点击绿色的“Merge pull request”按钮,将这些修改合并到主分支
点击“Confirm merge”按钮
由于这个分支的更改已经被合并了,所以我们还需要点击紫色框中的“Delete branch”按钮,删除这个分支
七、平台代码交流:
查看别人的代码、项目,进行点赞、评论、关注、clone代码。点击“Explore"
现在,你可以愉快地开始GitHub代码之旅啦!