open/CONTRIBUTING.md

10 lines
1.2 KiB
Markdown
Raw Normal View History

2025-01-18 18:46:10 +08:00
## 前言
非常感谢您愿意协助EasyExcel的开发EasyExcel成长离不开大家的贡献。但是为了合作的更有效率希望我们在贡献代码的时候能按照如下约定。
## 提前沟通
尽量把自己的想法和实现思路提前沟通可以通过issue,钉钉,QQ都可以可能很多问题我们内部已经讨论过由于各种原因后续不会支持但是您这边又开发好了这样容易浪费您的时间。
## 代码规范
请先安装阿里巴巴代码规约插件https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines
目前代码规范已经集成了自动校验然后源代码尽量不要有中文注释。在新增功能的时候尽量注意补充junit。core代表每次travis-ci都会跑的测试案例然后demo用于对外看到temp里面随便写。
## 提交分支
建议提交到最新的版本号.x上面比如 3.x之类的版本为了方便其他同学阅读源代码所以目前的思路是master和maven center的最新版本代码保持一致然后您提交过来的代码我们可能会稍微做一些修改。所以提交到开发分支会比较好。fork也可以直接fork该分支。