一个典型的项目
下面是这些条目,你很有可能在github上面的开源项目中碰到,因此,你需要提前熟悉。
社区
项目通常都有一个以项目为主题的社区,组成社区的用户扮演不同的角色。
拥有者 拥有者是创建该项目的用户或者组织,项目仓库位于拥有者的账户下面。
维护者和合作者 维护者和合作者是项目开发的主要人员并且决定项目的走向。大多时候拥有者和维护者是同一个用户。他们拥有对项目仓库的修改权限。
贡献者 贡献者是任何拥有一个被合并到项目的Pull Request的用户。
社区成员 社区成员是那些使用和关心项目的用户并且积极参与到项目功能和Pull Request的讨论中去的用户。
文档
文档是项目中介绍解释项目的常见文件
关于
几乎所有的github项目都包含了一个README.md文件,这个文件提供了一个具体叙述项目细节和使用方法、开发方法和贡献方法的场所,
贡献
项目和项目维护者不同,因此,做出贡献的绝佳方法也就不同。注意项目中命名为CONTRIBUTING的文档。这个文档的细节规定了所在项目的维护者希望看到的补丁或者功能的提交方式。者可能包含了怎么写测试,代码风格或者需要注意寻找补丁的地方。
许可
LICENSE文件是一个项目的额许可证书。一个开源程序许可文件告知用户他们可以做什么以及不可以做什么,也告知贡献者他们被允许做什么。开源项目有许多种许可方式。你可以在http://choosealicense.com/ 这个网站看到每一种许可证书的样式。
文档和维基
许多大型的项目不满足于使用README文件提供的指导用户使用他们的项目。在这种情况你可以在项目仓库中看到一个链接到一个命名为docs的文件或者文件夹。
github维基是一个可以替代docs的工作方式。
对一个项目做出贡献
通过之前的阅读,你已经可以了解到一个项目的大致脉络。下面的内容可以帮助你实施你对项目的贡献。
创建一个问题
如果你在一个你使用的项目中发现了一个bug但是你并不知道怎么去修复这个bug,或者在阅读文档过程中有困难又或者是对项目有疑问----那么久创建一个问题吧!这并没有什么而且无论你有什么问题,你都不是唯一一个,所以其他人会发现你的问题非常有帮助。
关于创建问题的一些建议
检查你发现的问题是否已经存在在问题列表中
问题描述尽量清楚到位
给出一个有关问题的链接
把错误信息粘贴到问题之中
完成Pull Request
当你发现了一个bug或者在问题列表中发现了一个bug而你可以通过自己的努力解决这个bug并且通过了测试,那么你可以通过对项目拥有这发起一个pull请求,希望将自己的工作合并到项目主分支中去。这样你就成为了项目的贡献者。