GitHub使用手册5——确定多人协作项目中你的任务

假设你正在使用某个第三方库构建一个项目,并且在使用此第三方库时遇到 bug 或拼写错误。

 

一、fork 其他开发者的仓库将其复制到你的帐户,这样你就有权限去修复它了。 

 

二、在项目中寻找一个名为 CONTRIBUTING.md 的文件。此文件列出了你要为项目做出贡献时所应遵循的信息

查看lighthouse项目的CONTRIBUTING.md文件()

 

三、进入GitHub 的 Issues 界面

    在修改之前,打开GitHub 的 Issues 界面,在这里以公开的方式向项目维护者提问,让每个人都能看到项目的动态,防止花费大量时间和精力做重复工作。

 

每个问题都可以:

  • 应用一个或多个标签

  • 被分配给个人

  • 确定一个里程碑(例如问题将由下一个主要版本解决)

每个问题都可以有自己的评论区,使开发者围绕这个问题展开对话。

  • 你可以订阅某个 Issue ,这样你便会获得新评论和代码更改的通知

  • 你可以就具体变更与项目维护者持续交流

 

    在向某个文件贡献任何内容之前,请查看 CONTRIBUTING.md 中的说明。然后查看项目的 Issue,看是否有哪些与你要贡献的内容类似。如果有,则订阅该 Issue 并阅读现有的对话,看你是否可以提供帮助。如果你查看了 Issues 列表,没有看到与你要做的事情类似的内容,那么你可以创建自己的新 Issue,等待项目开发者的回复再开始你的工作。(new issue就是订阅按钮

 

四、关于特性分支

主分支   保存整个项目的所有 commit 的默认分支

特性分支 仅保存单个概念或单个更改区域的 commit,它的命名一般都有要求,注意查看 CONTRIBUTING.md 文件

 

当开始开发后,将所有工作 commit 到特性分支上:

  • 不要在主分支上工作

  • 确保给特性分支赋予一个清晰、描述性的名称

 

编写 commit 的一般最佳实践

  • 频繁少量 commit

  • 使用清晰、具有描述性的提交说明

  • 必要情况下,更新 README 文件

 

posted @ 2020-03-18 16:01  super_sweet  阅读(205)  评论(0编辑  收藏  举报