Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

56 lines (44 loc) · 2.68 KB

目录

1、如何报告问题

如果在了解和使用过程中,有任何疑问,非常欢迎提出宝贵的 Issue

2、如何提交PR

PR的提交不限制范围,如代码、文档等修改均在允许范围内,可 参考这里 的PR提交

3、如何理解项目

HOWTOCODE文档中介绍了详细的实现原理和设计,帮助你了解项目

4、代码提交规约

在提交代码前,至少需要做到以下几项

(1) 单测通过

整个项目的单元测试必须通过

(2) commit message 规范

规范使用如fix: 修复Logger中记录日志时间错误的bug这种组合的提交规范

  • fix: 修复bug相关
  • doc: 文档完善相关
  • refactor: 重大功能重构
  • feat: 新功能、新组件等
  • test: 新增测试或测试相关的修改
  • style: 调整代码格式等对功能和性能无较大影响的修改
  • chore: 构建过程或辅助工具的变动,如dockerfile的修改

(3) 分支管理

v1版本的开发提交到v1.x分支,v2版本的开发提交到v2.x分支,且CI检查通过

(4) 提交内容注释

对于重要代码部分,请以评论的方式写清楚原因,可以参考 test: 添加环境变量的测试用例feat: 支持Composer和修复制作镜像失败时误提示成功的bug

5、打包Release

基于v1.xv2.x分支分别打包不同的Release版本。

6、版本对比

(1) Composer

主版本号 Composer 优势 劣势
v1.x 不支持 不需要安装Composer也可以用 可能无法正常使用外部依赖
v2.x 支持 可以方便的调用外部依赖 本地开发时需要安装Composer

7、项目数据