参与开发
我希望对开源有热情的童鞋都来贡献LiteFlow,让这个项目变的越来越好。
# 我要如何做才能成为Committer
需要你对开源有热情,技术扎实,有一颗用爱发电的心。
你需要加入LiteFlow的社区群,如何加入请参考加入社区讨论,然后私聊我,表示有意成为开发者。
你需要熟读源码,理解核心代码的逻辑。
然后可以去issue页 (opens new window)查看issue列表并进行认领。
或者你有相关建议自己进行创建issue并进行修复也是可以的。
在相关issue下回复“认领”就可以了,然后私聊告诉我。如果已经有相关同学已经认领了,请不要重复认领。
完成3个issue并成功通过审核并合并,我会邀请你成为Committer。
# 对于长期Committer的要求
需要对开源有热情,技术扎实,有一颗用爱发电的心。
理解核心代码逻辑。时刻保持学习的心。
需要每个月贡献至少1个PR并成功通过审核并合并。
需要参与社区群的建设,积极回答问题和进行宣传。
# 提交PR
LiteFlow的PR统一在Gitee平台上进行提交,如果你不知道如何提交PR,可以在Gitee平台里去学习。这里不作说明。
提PR有以下注意点。
- fork后切换到
dev
分支,请以这个分支为开发基准。 - 所有的PR提交到
dev
分支,这个分支为开发分支。 - 如果你作了功能性的变动,请带上你的测试用例,测试用例规范可以参考之前的测试用例。
- 所有的PR必须关联至少一个issue,如果没有相关issue,请自行创建一个。
- 正式提交PR之前,请确保所有的测试用例都通过。
- 提交信息,均要符合要求,下面有讲述。
# 注释以及Comment的要求
在文件头上,一定得有相关头注释信息,请按照规范,如下所示:
/**
* 这是你对这个类的描述,如比较长,多行也行
* @author Bryan.Zhang
* @since 2.6.4
*/
public class YourClass{
...
}
相关重要代码,为了保证阅读性,也请加上必要的注释
提交的时候comment也要按照规范来填写:
#bug/feature/enhancement/ #issue号 这是你issue的中文描述
举例:
enhancemnet #I595MU 在slot的元数据里增加每个组件执行的耗时和是否成功结果
# 写代码时要注意的点
开源框架的代码质量的要求会比较高,不仅是实现那么简单,还要考虑到各个环境的兼容性,优雅性和可读性。
所以在写代码时要多想一下。我相信,高标准高要求才能塑造一个优秀的框架。
在代码合并时,我会在PR下面给出修改意见,可能会比较苛刻,吹毛求疵点。请大家谅解,完全是针对代码质量而不是针对谁。
帮助我们改善此文档 (opens new window)
上次更新: 2022/09/01, 11:04:35