Skip to main content
Version: 1.5.x

如何贡献

非常欢迎大家参与到Forest开源项目中来,Forest如要继续服务更多的人,就离不开大家的帮助和贡献。

如何成为提交者#

  1. 需要对开源有热情,技术扎实

  2. 需要熟读Forest源码,理解Forest的设计

  3. 找作者在Gitee上分配Issue

  4. 帮助解决1个Issue并合并到master后,给提交者权限

  5. 帮助解决5个Issue,其中必须包含2个新特性Issue,给管理员权限

如何成为维护者#

  1. 需要对开源有热情

  2. 需要理解Forest的设计和核心代码

  3. 帮助回复Issue和维护官网文档

  4. 帮助推广和收集反馈

  5. 完成2,3点后,给提交者权限

代码提交规范#

  1. 进群讨论,可以在群里抛出您遇到的问题,或者在Gitee的Issue列表中搜索关键字,或许已经有人解决了或正在解决您的问题,避免重复。

  2. 找作者分配Issue,也可以自己直接提Issue,如果在Gitee的Issue中已经有您想解决的问题,可以直接将该Issue分配给您自己。

  3. Fork 本项目的仓库。

  4. 新建分支,如果是加新特性,分支名格式为feat${Issue的ID号},如果是修改bug,则命名为fix${Issue的ID号}。

  5. 编写该Issue相关的单元测试。

  6. 在代码注释的作者栏中加上自己的ID,新的方法或类请加上新的注释。

  7. 本地自测,提交前请通过所有的已经单元测试,以及为您要解决的问题新增单元测试。

  8. 新建 Pull Request。

  9. 我会对您的PR进行验证和测试,如通过测试,我会合到dev分支上随新版本发布时再合到master分支上。