从最经典的hello word 开始.
学习:
- 创建使用仓库
- 创建管理分支
- 修改提交文件
- 创建合并拉取请求
GitHub是什么?
GitHub是一个用于版本控制和协作的代码托管平台。
这个示例主要介绍 仓库,分支、提交、 拉取请求. 创建一个hellworld项目,演示开源项目拉取合并工作流程,最流行的代码审查工具。
自己操作 需要先在GitHub.com 注册一个账号。步骤 1:创建仓库
一个仓库包含一个项目. 仓库开源包含文件夹 文件 图片 视频等任何项目需要的文件。
推荐在根目录创建README文件,包含一些项目的介绍信息。
这个helloworld 仓库可用用来保存你的想法、资源、或者任何和其他人讨论分享的东西。
创建仓库
- 在右上角你头像旁边 点击+ New repository.
- 填写你仓库的名字 hello-world.
- 填写简单描述信息.
- 选择用 README初始化项目。
点击 Create repository.
步骤 2. 创建分支
分支可以在同一个仓库同时保存多个版本。
默认仓库有一个master 主分支,我们用分支来做一些实验的功能,修改测试后在提交到主分支。
在主分支创建分支的时候,分支是master一个快照。
这里有个图:
- 最开始是master主分支
- 然后创建一个feature分支,我们将在这个分支开发新功能
- feature分支显示了整个开发过程,最后合并到master分支上。
你有保存过不同版本的文件吗 例如:
- story.txt
- story-joe-edit.txt
- story-joe-edit-reviewed.txt
分支实现了类似效果.
在GitHub上,开发者在分支上写代码 做设计 开发新功能或者修复bug,当开发完成后分支将合并到master主分支上。
创建一个分支
- 点击进入创建仓库 hello-world.
- 点击下拉列表框 branch: master.
- 输入分支名称 readme-edits.
- 选择 Create branch 选项 或者 输入 回车 键.
现在有两个分支了 master 和 readme-edits. 现在他们是完全相同的,我们将在新分支上面修改文件。
步骤3. 修改并提交
现在你在readme-edits分支的查看代码,接下来我们做一些修改.
在GitHub,保存修改操作叫做 commit (提交),每个提交关联一个提交消息,用来描述修改的内容,提交消息保存每次修改的历史记录,因此其他人可以通过历史记录,看懂你在做什么操作。
修改提交
- 点击 README.md 文件.
- 点击 右上角的 铅笔工具 ,打开编辑器
- 在编辑器里面 随便写一些介绍信息.
- 在下面写上此次修改提交描述信息.
- 点击按钮 Commit changes .
提交后 readme-edits的 README 文件将会被修改,和主分支不一样了。
步骤 4. 创建一个 Pull Request
现在你在主分支外的另一个分支修改了文件内容,
下面可以创建一个pull Requests,把修改合并到主分支上。
Pull Requests 是GitHub 代码协作的核心。创建pull request表示你将提交你的修改并请求别人review 拉取你的贡献,并合并到 主分支上面。
pull request 会显示你的修改内容, 增加的 或者减少,用绿色或者红色显示。
提交commit后,你就可以立即创建一个pull request .
可以用GitHub @ 功能 在创建pull request希望得到某人的反馈 ,
你也可以自己review pull request,自己合并,练习下整个流程。
打开一个修改README 的Pull Request
点击图片打开大图
点击 Pull Request 标签, 点击
New pull request 按钮.选择分支 readme-edits, 和 master (主分支) 比较.
在比较页面查看修改内容,确认是需要提交的修改。
如果满意此次修改,点击 Create Pull Request按钮
填写 pull request 请求标题,和简短描述信息
点击Create pull request
步骤 5. 合并 Pull Request
最后一步, 把所有修改合并到主分支 master上面
- 点击绿色 按钮 Merge pull request 合并修改到master分支.
- 点击 Confirm merge.
- 合并后可以删除readme-edits分支,因为已经合并步在需要此分支,点击紫色框内 Delete branch 按钮.
总结!
通过这个示例,学习到如何在GitHub创建项目,创建 pull request 。
包括:
- 创建打开一个项目
- 开始管理一个分支
- 修改提交一个文件
- 打开合并一个 Pull Request
打开你的GitHub profile,将会看到新创建的开源项目。
详细的git命令使用,可参考其他文档。
閱讀更多 開源項目分享 的文章