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

参与开源

参与贡献

  1. 框架代码:参与框架功能开发、单元测试、ISSUE提交、反馈建议等等,https://github.com/gogf/gf
  2. 开发文档:参与WIKI文档的撰写,便于更多的人了解、热爱并加入团队,https://goframe.org 

贡献流程

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

协作约定

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