Skip to main content

贡献准则

· 3 min read
铂赛东

我希望对开源有热情的童鞋都来贡献LiteFlow,让这个项目变的越来越好

社区有很多童鞋愿意贡献这个项目,以下我整理了贡献准则

如何成为Committer

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

  • 需要熟读LiteFlow源码,理解LiteFlow的设计

  • 自己在Gitee上认领Issue,评论认领即可领取Issue

  • 帮助解决2个Issue并通过审核合并到master后,给提交者权限

  • 提供6个测试用例后,审核通过合并到master,给提交者权限

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

代码提交规范

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

2.Fork 本项目的仓库。

3.新建分支,如果是加新特性,分支名格式为feature_Issue的ID号,如果是修改bug,则命名为bug_Issue的ID号,如果是增强,则命名为enhancement_Issue的ID号

4.编写好代码之后,记得编写该Issue相关的单元测试。

5.在代码注释的作者栏中加上自己的ID,新的方法或类请加上新的注释。可以参考之前的注释。

6.提交代码的Commit Message格式为feature(如果是bug或者增强请换相应的类型) #Issue的ID号 ISSUE的描述,比如:bug #I3IG1K springboot的fat jar模式下,流程文件会找不到的问题

7.提交自己的代码到fork仓库的分支,同时创建PR,把自己的分支名告诉作者,让作者在项目里也创建同样的分支名,然后提PR到相应的分支。

8.我会对您的PR进行验证和测试,如通过测试,我会合到相应的分支上随版发布。