参与贡献
欢迎您加入和我们一起贡献Easy-Es,让这个项目变的越来越好。
# 要求
社区有很多童鞋愿意贡献这个项目,如果你想参与开发,成为committer,有以下要求:
需要对开源有热情,技术扎实,有一颗用爱发电的心。
需要有一定空余时间能参与开发和阅读源码。
需要持续发光发热,而不是一时兴起。
# 如何加入开发团队
首先你需要加入Easy-Es的社区群,如何加入请参考加入社区讨论,然后私聊我,表示有意成为开发者。
贡献有价值PR后,我会把你拉入开发者团队。
# 如何认领任务
我会不定期的在开发者团队群里push出一些issue,采用自己认领的方式。
在相关issue下回复“认领”就可以了,不用在群里回复。如果已经有相关人员认领了,请不要重复认领。
需求池和规划中的功能都可以认领,也可以自行发挥,只要是你认为有价值的功能,都可以尝试Push。
# 提交PR
Easy-Es的PR统一在Gitee平台上进行提交,如果你不知道如何提交PR,可以在Gitee平台里去学习。这里不作说明。
提PR有以下注意点。
- fork后切换到
feature
分支,请以这个分支为开发基准。 - 所有的PR提交到
feature
分支,这个分支为开发分支。 - 如果你作了功能性的变动,请带上你的测试用例,测试用例规范可以参考之前的测试用例。
- 所有的PR必须关联至少一个issue,如果没有相关issue,请自行创建一个。
- 正式提交PR之前,请确保所有的测试用例都通过。
- 提交信息,均要符合要求,下面有讲述。
# 注释以及Comment的要求
在文件头上,一定得有相关头注释信息,请按照规范,如下所示:
/**
* 这是你对这个类的描述,如比较长,多行也行
* @author 老汉
* @since 2.6.4
*/
public class YourClass{
...
}
2
3
4
5
6
7
8
相关重要代码,为了保证阅读性,也请加上必要的注释, 并尽量遵循阿里巴巴代码开发规约
提交的时候comment也要按照规范来填写:
#bug/future/enhancement/ #issue号 这是你issue的中文描述
举例:
enhancemnet #I595MU 在slot的元数据里增加每个组件执行的耗时和是否成功结果
# 写代码时要注意的点
开源框架的代码质量的要求会比较高,不仅是实现那么简单,还要考虑到各个环境的兼容性,优雅性和可读性。
所以在写代码时要多想一下。我相信,高标准高要求才能塑造一个优秀的框架, 这对您未来的技术成长也会非常有帮助。
在代码合并时,我会在PR下面给出修改意见,可能会比较苛刻,吹毛求疵。请大家谅解,完全是针对代码质量而不是针
对谁。开源项目要想长久发展,代码质量肯定是要严格把控的,否则这么多开发者,人手一套风格,最终将难以维护。
# 我想对Committer说的话
熟读代码+完成一个issue并合并到master分支的时候,我会邀请你成为Easy-Es的Committer,通常会在发版前统一邀请。
虽然原则上只需要完成一个issue,issue本身难易程度也有区别,但我希望作为贡献者的你不要满足只提交一个issue,希望
你能成为长期的Committer,来一起参与Easy-Es这个框架的迭代和发展和决策讨论中。只有这样,开源框架才能发展的更
加蓬勃,开源也会作为你成长和技术提高的途径。