无规矩不成方圆,在涉及多人协作的项目中,对版本控制系统的提交使用适合于组织的规范,有助于简化后期的管理维护。
人生苦短,规范提交
提交信息修改规范
每次提交,请写明提交信息,并按规定书写提交信息。规范化的提交信息除了便于查阅外,还容易被自动化工具处理。
一种参考的格式:
修改类型[(影响范围)]: 标题
<--空行-->
[正文]
<--空行-->
[页脚]
一般而言修改类型和标题是强制性的,影响范围,正文,页脚是可选的,但实际情况可以依据具体情形灵活确定。
修改类型(type)
修改类型是用于说明该 commit 的类型的,type 的参考类型如下,根据实际情况可以进行增减:
- feat: 新功能(feature)
- fix: 修复 bug
- docs: 只修改了文档(documents)
- style: 代码格式(不影响代码运行的格式变动,注意不是指 CSS 的修改)
- refactor: 重构(既不是新增功能,也不是修改 bug 的代码变动)
- test: 提交测试代码(单元测试,集成测试等)
- chore: 构建或辅助工具的变动
- misc: 一些未归类或不知道将它归类到什么方面的提交
影响范围(scope)
影响范围说明 commit 影响的范围,比如数据层还是控制层,业务A还是业务B