1.4 KiB
1.4 KiB
前言
git作为一个开发人员必不可少的工具,代码提交也是日常一个非常频繁的操作,如果你或你的团队目前对提交信息还没有一个提交规范或约束,那么你有必要看看本文的内容了。
为什么要规范提交信息
首先规范提交信息肯定是有必要的,简单总结下几点好处:
- 让项目的维护或使用人员能了解提交了哪些更改
- 清晰的历史记录,可能某天自己就需要查到呢
- 规范的提交记录可用于自动生成修改日志(CHANGELOG.MD)
- 基于提交类型,触发构建和部署流程
使用什么规范
Conventional Commits(约定式提交规范),是目前使用最广泛的提交信息规范,其主要受 AngularJS规范 的启发。
如何约束规范
怎么确保每个提交都能符合规范呢,最好的方式就是通过工具来生成和校验,commitizen是一个nodejs命令行工具,通过交互的方式,生成符合规范的git commit
对于开发人员,各种IDE上可以安装插件来配置提交规范。比如jb的IDE,可以安装 Git Commit Template 插件来实现。
对于git服务器,可以配置 git hooks 来约束提交。