GitHub 项目协作的方法

1 提交到一个分支

https://github.com/pragmaticlearning/single-repo-example 为例。

如果想扩展 readme.md 文件,需要做的第一件事是创建一个分支,以使得修改时保持独立。

单击 branch:master 按钮,就将创建一个该工程下当前分支的下拉列表和一个文本框,可以输入现存分支或你想创建的新分支的名字。

可以根据提示创建一个updata_readme分支,点击进入,接下来可以开始做一些改变。

当前提交仅提交到当前分支下,最后可通过拉请求开始讨论所有的修改建议。

2 从分支中创建拉请求

单击 create pull request 按钮,选择在哪两个分支之间创建一个拉请求。

base分支是想要合并到的对应分支(很可能是主分支),compare分支是希望合并到主分支的那个分支。

3 pull请求合作

pull请求的目的是启动一个关于所提变更的会话,通常是一个新功能或一个Bug的修复。

创建一个新分支,在上面进行所有的修改直到完成工作。pull请求的目的就像一个双重检查,在改变合并到主分支并推送到发布之前,确保团队的其他人同意你做出的改变。

如果有一个关于修改的想法但是并不确定它是否是一个好的想法时,考虑创建一个分支开始简单的工作,然后创建一个pull请求和团队进行讨论。

3.1 pull请求涉及的人

若已经创建了pull请求,并想从团队的特定成员处得到反馈,可以使用@mention功能来提及他们。

@mention功能需要在pull请求本身或者pull请求的一个描述内,输入@然后输出GitHub用户名。若此人是该项目的所有者或合作者,用户名将会自动输入。

3.2 回顾pull请求

若想知道人们在一个项目上做什么工作,去项目主页单击右边的拉请求选项卡,将看到一个包含所有当前开放的pull请求列表。

当你找到一个想要审查的pull请求时,单击它来查看pull请求的详细信息页面。

3.3 评论pull请求

若收到电子邮件或网页通知,告知在pull请求中被提到,一定要尽快花时间检查一下并提供一些有用的反馈信息。

浏览pull请求页面,去评论框,输入你的反馈,单击评论按钮即可。

3.4 给评论添加色彩

GitHub内置有对emoji的支持,或使用gif格式的动画为评论添加一些更多的色彩。

3.5 对pull请求做共贡献

为做出改变,所需的就是转到项目主页并从分支下拉列表中选择自己的分支。编辑完成后选择提交。

3.6 测试一个pull请求

有些不能仅从表面上审查的包括实质性代码更改的pull请求,在赞同之前应该下载库的一个副本,然后检查pull请求相关的分支运行自动化测试,以确保能正常通过。

3.7 合并pull请求

当准备合并pull请求时,只需要单击绿色的 Merge pull request 按钮,输入提交的信息,单击Confirm merge即可完成合并,pull请求会合并关闭。

3.8 谁应该合并pull请求?

其实一般由创建的人进行pull请求的合并是较好的,因为他们最了解自己的更改,对可能造成的一些影响也能最快做出反应。

但是在合并之前应至少得到两位团队成员的赞同。

3.9 pull请求通知

若创建了一个pull请求,诸如发表评论、提交或是被@mentioned提及,默认情况下会订阅该pull请求。这意味着每当有人评论、提交、合并或关闭该pull请求时,都将接到一个通知。

若不再对已经订阅的pull请求感兴趣,单击Unsabscribe按钮就会停止接收通知。若被重新@mention则会自动变为重新订阅。

若没有订阅想要关注的pull请求,则可点击pull请求的subscribe按钮,即可开始接收有关pull请求的任何活动通知。

3.10 pull请求的最佳实践

  • 做每件事情都创建pull请求
    想要修复故障或添加功能都要确保在一个分支上完成这些修改,然后创建一个pull请求以得到输入内容,最后合并到主分支。
  • 使标题具有描述性
    便于别人能快速理解。
  • 花费一些时间去评论
    可对跟踪最新的一些进展信息。
  • @mention主要人物
    使得能得到及时、想要的反馈信息。
  • 运行测试
    很多时候仅仅从表面上查看代码是远远不够的。
  • 赞同一个pull请求要有一个明确的策略
    及时帮助他人完成合并工作。

4 问题

4.1 创建一个新的issue

要创建一个新的问题,单击问题选项卡,然后点击 New issue。即可看到下图界面。

在这里插入图片描述

输入一个描述性的标题,使人快速知道你想要表达的缺陷或功能。

如果知道谁应该复杂这个问题,可以通过单击No one is assigned 文本标签右边的按钮,从贡献者下拉列表中选择此人。

可指定一个时间表milestone,页面右边可选择所有适合的标签。

完成后单击底部绿色的 Submit new issue 来创建问题。

4.2 管理问题的时间表

问题的时间表功能通常用于为问题分配一个特定的冲刺时间(sprint)。

点击Issues后点击Milestones按钮,再点击 create a milestone 按钮,用来创建一个新的日程表。

在这里插入图片描述

在这里插入图片描述
在这里插入图片描述
点击后可选择到期日期、标题和可选的描述。

完成后点击 Create milestone 按钮可看到新的日程添加到你的列表,现在可以编辑这个日程表,关闭、删除或浏览与日程表有关联的问题列表。

4.3 问题管理标签

点击 Issues 再点击 Labels 可为项目创建一些自定义标签,可以编辑(Edit)标题、颜色、删除(Delete)和创建新标签(New label + Create)。

4.4 评论问题

对于pull请求:

  • 评论一个问题只需要单击issue,向下滚动到评论框,输入你的评论,然后单击Commont按钮。
  • 确保每天花一点时间,看看是否有任何新的问题,尽快应对任何@mention ASAP。
  • 随机使用emoji表情符号和gif动画给协作过程添加一点乐趣。

4.5 提交中引用问题

若做的提交是和某个问题有关,只需要在提交信息中包括一个 # 符号,后边是问题的编号,则该提交可显示在这个问题的历史记录中。

4.6 问题的最佳实践

  • 创建“Bug”和“Feature”标签
    可以容易地仅看到显著的错误或功能。
  • 如果符合你的工作流程则使用流程表
    如果有外部截止日期或一个基于内部节奏的冲刺,随意使用日程表指派问题的交付日期。
    如果不使用基于日期的交付,可考虑使用日程表。
  • 分配问题时要小心
    最好由团队成员的兴趣分配工作。
  • 广泛使用标签
    可以考虑添加标签来跟踪工作状态,将工作分配给不同的群体,甚至可用于跟踪其他有趣的信息。

5 WiKi

在项目整个生命周期的某时刻,READ.md将开始变得太长从而影响使用,此时可考虑使用Wiki。

Wiki是一个非常简单的内容管理系统,可让一群合作者便捷地建立一组相互链接的页面。

通常,GitHub wiki 用于捕获终端用户的文档、开发人员文档,或者两者都有,因此相关的所有信息都可通过项目的GitHub页面访问。

5.1 开始使用wiki

进入Settings,勾选Wikis。
在这里插入图片描述然后点击‘wiki’,即可看到如下界面。
在这里插入图片描述
点击 create the first page就将看到如下界面。
在这里插入图片描述
初始默认为home,但是可做修改。

可在本文区域设置内容,点击区域上方的按钮用于样式设置,点击Preview选项卡可进行预览。

完成内容编辑后,在Edit message文本框中输入一个简单的描述,然后单击Save page进行保存。

5.2 添加且连接到你的wiki页面

任何时候想要添加一个wiki页面,只需点击任何wiki页面右上角的new page按钮,将允许向网站添加一个页面。

完成添加页面后,它将出现在屏幕右边的page部分。

复制想要链接到的页面的URL,在想要添加链接的页面点击右侧页面顶部的Edit按钮,点击顶部的链接按钮会弹出对话框,输入链接确定即可。

6 GitHub页面

wiki在GitHub上是一个用于创建文档的强大工具,因为他们位于代码的右边,比一个单独的文件更能保持更新状态。

然而,有时候想创建一个更用户化的网站,分享关于自己、组织或项目信息,这就是GitHub页面。

GitHub页面是一个功能,允许你创建页面并拥有GitHub页面主权。

6.1 为你的项目创建一个网站

每当在GitHub上创建一个存储库,就可以选择添加GitHub页面,为推广或描述该项目提供一个web页面。

开始使用GitHub页面时,单击settings,向下滚动到GitHub页面区域,单击 Automatic page generator 按钮。

表单允许输入一个项目名,一个口号,一个主体。

可以在主体区为使用Markdown的页面创建一个第一次剪切的内容,并且还有一个添加跟踪ID的选项,如果希望跟踪,则使用Google分析来记录交通信息。

一旦完成了第一页的输入,单击 Continue to layout 按钮,将进入主题布局页面。

点击右上角的Publish page,网站将被重建,可以在项目页查看网站。

当为一个项目创建一个GitHub页面时,底层会为你的项目添加一个新的gh-pages分支。

在下拉列表中选择该分支,会看到一个生成的网站代码,可使用HTML和CSS对其进行定制。

6.2 为自己或自己的组织创建一个网站

若想为自己或自己的组织创建一个网站,需要创建一个名为username.github.io的项目。

对于个人和组织的GitHub页面,不是添加一个gh-pages分支,而是使用你的主分支内容建立你的网站。

若想为组织创建一个网站,去组织的主页,单击 +New repository 按钮。

一定要确保存储库名为 organization_name.github.io,然后勾选 Initial this repository with a README 复选框。

如果你创建这样一个项目,单击Setting链接,并向下滚动到GitHub页面部分,将看到已经发布一个GitHub页面网站的信息。

如果你了解HTML和CSS,可在这里建立你的网站。如果想利用内置生成器,可以通过单击 Automatic page generator 按钮重建这个项目,将会如 GitHub 网站项目页一样工作。

参考:《GitHub入门》

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章