此文为GitHub官网操作示例,英文原版见下文或访问地址:Hello World · GitHub Guides
Hello World
十分钟教学指南
Hello World项目在计算机编程领域是一个历史悠久的传统。当你学习一些新的东西的时候,它是你开始学习的一个简单的练习。让我们开启使用Github之旅吧!
你将会学习到如何使用下面这些:
● 创建和使用一个仓库
● 启动和管理一个新的分支
● 对文件进行更改并按提交方式推送到GitHub上
● 打开并合并一个pull请求
什么是GitHub?
GitHub是一个版本控制和协作的代码托管平台,它可以让你和其他人在任何地方一起进行项目开发。
这个教程教你GitHub的必备知识,如仓库、分支、提交和拉取请求,你将创建你自己的Hello World仓库并且学习GitHub的拉取请求工作流,这是一种非常流行的创建和审核代码的方法。
无需编写代码
要完成本教程,你需要一个GitHub.com的账户以及可以访问互联网。你不需要知道如何进行编码,如何使用命令行或者安装Git(版本控制软件GitHub是在此基础上创建的)。
提示:在单独的浏览器窗口(或标签页)打开这份指南,这样你就可以一边看着指南一边完成操作了。
第一步.创建一个仓库
一个仓库通常用来组织一个单独的项目。仓库中可以包含文件夹和文件、图像、视频、电子表格和数据集等-你项目需要的任何内容。我们建议包含一个README文件,或者一个有关你项目信息的文件。GitHub让你在创建一个新仓库的同时很容易的添加一个此类文件。它也提供其他的常用选项,例如许可证文件。
你的“Hello-World”仓库是一个你存储想法、资源,甚至是你与其他人分享和讨论事情的地方。
创建一个新的仓库
1、在右上角,你的图像或标识符旁边,点击“+”,然后选择“New repository”(新的仓库)。
2、将新建的仓库命名为: hello-world。
3、写一个简短的描述。
4、勾选“Initialize this repository with a README”(使用自述文件初始化此仓库)。
点击Create repository(创建仓库)按钮。
第二步.创建一个分支
分支是一个在同一时间工作在一个仓库不同版本的方法。
在默认情况下,你的仓库有一个名称为main的分支,这个分支被认为是最终的分支。在提交到main分支之前,我们用其他分支来进行更改和编辑。
当你在main分支上创建一个子分支时,在你创建的那一刻你就对main分支做了一次拷贝或快照。当你正在你的分支上工作的时候,其他的一些人对main分支进行了改变,你可以拉取到这些更新。
这个图展示:
● main分支
● 名为feature的新分支(因为我们正在这个分支上做开发)
● 在feature合并到main之前的历程
你曾经保存过一个文件的不同版本吗?像这样:
● story.txt
● story-joy-edit.txt
● story-joy-edit-reviewed.txt
在GitHub仓库里分支实现类似的目标。
在GitHub里,我们的开发者、编辑者和设计人员使用与我们的main(产品)分支是分开的其他分支进行问题修复和功能开发工作。当一个改变准备就绪时,他们就将自己的分支合并到main上。
创建一个新的分支
1、回到你新建的仓库:hello-world
2、点击文件列表上方叫做"branch: main"的下拉框
3、在一个新的分支文本框里从键盘上输入分支名称:readme-edits
4、选择蓝色背景的Create branch框,或者直接按键盘上的“Enter”
现在你有了两个分支,main和readme-edits,他们看起来是完全一样的,但是不会持续很久。接下来,我们在我们新建的分支上做一些修改。
第三步.做修改并提交
现在,你看到的是readme-edits分支的代码视图,它是main分支的副本,让我们来编辑它。
在GitHub上,保存更改被称之为提交。每一次提交都会有一个备注说明,它用来描述提交者为什么要做这些修改。提交备注信息记录着你的修改历史,因此其他参与者就知道你修改了什么并且为什么要修改。
做修改并提交
1、点击 README.md 文件
2、点击视图右上角的钢笔图标,进入编辑界面。
3、在编辑框里,写一些你想写的东西。
4、写一个提交备注消息来描述你的修改
5、点击Commit changes(提交修改)按钮
这些修改仅仅只是针对你的readme-edits分支里的README文件,因此,现在这个分支包含的内容是不同于main分支的。
第四步.开启一个拉取请求
编辑的很好!现在,你对main之外的新分支做了修改,你可以开启一个拉取请求(或发出“合并修改”的请求)。
在GitHub上,pull(拉取)请求是协作的核心。当你开启一个pull(拉取)请求的时候,你提出了你的更改并请求一些人审核,然后拷贝你贡献的代码并将它们合并到他们的分支上。pull(拉取)请求会显示来自于两个分支内容的不同或差异。用红色和绿色来显示这些改变,增加和减少。
一旦你进行了一个提交,即使在代码完成之前,你能够开启一个pull(拉取)请求并且展开一场讨论。
通过使用你的pull(拉取)请求消息里的GitHub@提到功能,你可以从指定的人或团队里得到反馈,而不管他们是在大厅还是相隔10个时区之外。
你甚至可以向自己的仓库发起pull(拉取)请求并且自己合并它们,这个一个在你做大型项目之前学习GitHub的好办法。
为README文件的修改发起一个pull(拉取)请求
(点击图像查看大图)
步骤
1. 点击“pull request ”(拉取请求)标签,然后在拉取请求页面,点击绿色的“New pull request”(创建新的拉取请求)按钮。
2. 在“ Example Comparisons”对话框里,选择你的分支,readme-edits,与main分支进行比较
3、在比较页面上,查看你修改的点,确保它们就是你想要提交的。
4、当你确定这些更改是你想要提交的时候,点击那个大的绿色Create Pull Request(创建拉取请求)按钮。
5、给你的pull(拉取)请求添加一个标题,为你的修改写一个简短的描述。
当你完成这些信息的时候,点击Create pull request(创建拉取请求)!
提示:你可以使用表情符号和拖拽图片和动态图到评论区和pull(拉取)请求上。
第五步. 合并你的pull(拉取)请求
在这最后一步,是时候把你的修改整合到一起了——合并你的readme-edits到main分支。
1、点击绿色的Merge pull request(合并拉取请求)按钮,合并修改到main。
2、点击Confirm merge。
3、由于分支的修改已经被合并了,使用紫色对话框里的Delete branch按钮,着手删除这个分支。
大功告成!
学完这个教程,你已经学会了在GitHub上创建一个项目和发出pull(拉取)请求。
下面是你在本教程里完成的内容:
● 创建一个开源仓库
● 开启和管理一个新的分支
● 更改一个文件并且提交这些更改到GitHub上
● 发起和合并一个pull(拉取)请求
看看你的GitHub的个人资料,你会看到你新的贡献值。
要学习pull(拉取)请求的更多功能,我们推荐阅读GitHub流程指导。你也可以访问GitHub网站并参与一个开源项目。
提示:查看我们其他的指南,YouTube 频道和需求培训,了解如何开始使用GitHub的更多信息。