本篇介绍两个规范,一个是commit规范,另一个是tag规范。
commit规范
提交格式:type(scope): message
参数说明
type:代码提交类型,不同类型表示不同的代码改动,比如:
- feat:新功能开发
- fix:bug修复
- docs:文档改动
- style:格式改动,包括空格、缩进、分号等
- refactor:代码重构
- perf:性能优化
- test:增加或修改测试用例
- revert:撤销上次commit
- chore:对构建过程或辅助工具和库的更改,如生成文档
scope:影响范围
message:变更简短说明
前期可考虑使用commitizen工具,便捷生成commit规范格式
tag规范
- 采用语义化版本控制规范SemVer。一来明确依赖范围,如依赖库版本定为
>=1.1.0 <2.0.0,自动安全升级兼容的新版本;二来促进协作,通过版本号传递变更意图,减少依赖冲突和沟通成本 - 版本号格式:主版本号x.次版本号y.修订号z
- 版本号递增规则
- 主版本号x:做了不兼容的API修改
- 次版本号y:做了向下兼容的新功能或弃用标记
- 修订号z:做了向下兼容的问题修复
- 特殊版本规则
- 0.y.z:开发阶段,不稳定,一切可能变更
- 1.0.0:可用于生产的正式稳定版
- 先行版本号:标注在修订号后,用短横杆连接,如1.0.0-alpha。表示测试版,优先级低于正式版,即1.0.0大于1.0.0-alpha
- 版本编译信息:标注在修订号后,用加号连接,如1.0.0+build。不影响版本优先级比较
