一、需求场景
在一个开发团队中,前端开发的代码管理越来越规范化、工程化,而代码commit更是需要一个统一的规范去约束,保证代码commit时的规范性。尤其多人参与一个项目开发时,大家的代码commit风格不相同,不便于后续的代码统一管理和可读性;所以良好的git commit风格是很重要的。
二、使用工具
1、commitlint
很多时候我们提交代码时,运行
git commmit -m 'xxx'
即可,而commitlint可以对message进行约束,是判断message是否符合格式要求的工具。commitlint 推荐结合config-conventional 配置使用,正确的提交格式是:git commit -m <type>[optional scope]: <description>
type :说明代码提交的类型。
optional scope:一个可选的修改范围。
description:描述提交的主要内容。
常见的type类型
- feat:新功能
-
fix:Bug 修复
-
docs:文档更新
-
style:代码样式更改,例如空格、格式、缺少分号等
-
refactor:重构代码