贡献内容大概可以分为两类:代码贡献 和 文档贡献。
一、代码贡献
在主库中有很多打上help wanted
标签的issue
,这些都期望得到社区小伙伴们的贡献:
2)单元测试覆盖率
2、代码贡献流程
- 首先
fork
一份仓库代码到自己的版本库中; - 在自己的版本库中创建一个
pull request
,源分支选择自己的开发分支,目标分支选择主库的master
分支:https://help.github.com/en/articles/creating-a-pull-request - 提交
pull request
请求,随后等待由项目的开发作者对提交内容做code review
。如果长时间没有被code review
,可以主动跟进、找到团队成员提出code review
要求。审核通过之后你将成为GoFrame
框架的成员之一。 - 恭喜你,你的名字将永久地载入到
GoFrame
框架源代码的贡献列表中;
- 所有源码文件、类型、方法都要有详尽的注释;
- 如果逻辑复杂的程序部分需要阐述实现思路;
- 新增的功能/模块必须要有单元测试,并且覆盖率达到
80%
以上;
二、文档贡献
1、官网WIKI完善
GoFrame
框架的文档主要集中在WIKI
中,地址:https://goframe.org
大家在阅读文档的过程中,如果不太完善的地方,可以点击编辑页面帮忙完善。特别是组件、功能的使用示例,往往都可以补充上去。
3、博客及视频教程
社区的小伙伴可以编写文章或者录制视频分享,方便社区其他小伙伴通过搜索引擎查阅到你的分享,便于相互学习,以及开源项目推广。
在文章中请保持统一的框架名称关键字:,请勿采用缩写名称。