如何贡献代码
Joe edited this page Apr 14, 2018
·
4 revisions
- 1: 先fork项目到自己的仓库，然后clone到本地，当前开发分支为1.6.1.20180301,不能往主干提交.
- 2: 完成上述操作后就可以在本地进行开发了。开发完毕后首先提交到自己的仓库中（fork出来的仓库），提交的时候注意一定要使用正确的开发者信息，即email和user选项，email要使用自己git账号绑定的email
- 3: 在github上点击提交PR（pull request），写上正确的信息即可。
PS：如果是对应某个issue的解决方案那么建议在comment中加上#issue编号，这样该PR也会同步更新到issue中去，方便让提交issue用户知道问题已经被解决。最后就是如果PR被采用或者因为某些原因被拒绝请及时关闭（可以点击close pull request）。
-
兼容性
由于框架要考虑到一些较老JDK用户的兼容，所以开发中使用的所有API必须要兼容1.6，也就是1.7及以上的特性不能使用。
-
测试覆盖率
新增功能需要增加测试用例。
新提交PR的测试覆盖率必须大于等于之前版本！
-
代码注释
新增字段及方法要加上说明，尽量不要对使用环境做假设，例如假设用户主机日期一定正确而依赖于日期做一些处理，如果不能避免那么要详细的说明对哪些依赖做了假设和为什么这样做。尽量早的将问题暴露出来，例如NullPointException等，对用户参数及时处理，不要到运行时才去检查参数的正确性和环境的正确性。
-
代码越少越好
框架本身仅是要解决jar包加载隔离问题，所以尽量不要引入太多外部依赖，要做到小而美，而不是大而全。