跳到主要内容
版本:2.1.x

GoFrame 是开源的、免费的软件,这意味着任何人都可以为其开发和进步贡献力量。 GoFrame 的项目源代码目前同时托管在 github(主库)和 gitee(国内)平台上,两个平台的仓库保持即时的同步,代码贡献统一使用 github 主库。我们非常欢迎有更多的朋友加入到 GoFrame 框架的开发中来,您为 GoFrame 所做出的任何贡献都将会被记录到 GoFrame 的史册中。

贡献内容大概可以分为两类: 代码贡献文档贡献

一、代码贡献

1、哪里找到任务

1)需要帮助的issue

在主库 issue 中有很多打上 help wanted 标签的 issue,这些都期望得到社区小伙伴们的贡献: 地址戳这里

2)单元测试覆盖率

具体请查看章节: 可维护性建设:单测覆盖率

2、代码贡献流程

  1. 首先 fork 一份仓库代码到自己的版本库中;
  2. 在自己的版本库中新建开发分支并对代码做修改,随后提交修改到自己的版本库;
  3. 在自己的版本库中创建一个 pull request,源分支选择自己的开发分支,目标分支选择主库的 master 分支: https://help.github.com/en/articles/creating-a-pull-request
  4. 提交 pull request 请求,随后等待由项目的开发作者对提交内容做 code review。如果 pull request 长时间没有被 code review,可以主动跟进、找到团队成员提出 code review 要求。审核通过之后你将成为 GoFrame 框架的成员之一。
  5. 恭喜你,你的名字将永久地载入到 GoFrame 框架源代码的贡献列表中;

3、代码协作约定

  1. 所有源码文件、类型、方法都要有详尽的注释;
  2. 如果逻辑复杂的程序部分需要阐述实现思路;
  3. 所有的注释都使用英文阐述,不再使用中文;
  4. 新增的功能/模块必须要有单元测试,并且覆盖率达到 80% 以上;

二、文档贡献

1、官网WIKI完善

GoFrame 框架的文档主要集中在 WIKI 中,地址: https://goframe.org

大家在阅读文档的过程中,如果不太完善的地方,可以点击编辑页面帮忙完善。特别是组件、功能的使用示例,往往都可以补充上去。

2、社区文档贡献

在官网中有专门的社区文档贡献空间,大家均可以往里面添加文章,例如,框架的使用感悟、常见问题、项目分享等等。地址: GoFrame社区投稿

3、博客及视频教程

社区的小伙伴可以编写文章或者录制视频分享,方便社区其他小伙伴通过搜索引擎查阅到你的分享,便于相互学习,以及开源项目推广。

在文章中请保持统一的框架名称关键字: GoFrame,请勿采用缩写名称。

三、其他帮助

任何帮助可联系 郭强 ,微信号 389961817。我将为你提供必要的指导和帮助。