团队协作第一课:写一条规范的 Git 提交信息
翻一翻很多项目的提交历史:fix、修改、123、asdf——半年后想找“到底是哪次改动引入的 bug”,基本只能靠考古。提交信息是写给未来的自己和同事看的,花十秒写规范一点,回报远大于投入。
一、最流行的约定:Conventional Commits
它的格式只有一行:type(scope): 描述。常用的 type 就这几个:
feat 新功能 fix 修复缺陷 docs 只改文档 style 格式调整(不影响逻辑) refactor 重构(既不是新增也不是修复) perf 性能优化 test 补测试 chore 构建、依赖等杂项
例如:feat(login): 支持手机号验证码登录、fix(cart): 修复数量为 0 时仍可下单。scope 是可选的模块名,团队小可以不写。
二、描述怎么写
三个原则:祈使句、不加句号、写“为什么”。feat login: add sms login 是机器味写法;支持手机号验证码登录,解决海外用户收不到邮箱验证的问题 才是人话——半年后你想知道为什么加这个功能时,答案就在提交信息里。
三、用工具而不是靠自觉
约定靠人守必然滑坡,交给工具:提交时用 commitlint 校验格式,不合规范的直接拒绝;配合 husky 把校验挂到 git commit 钩子上;再配合交互式工具生成,其实比手写还快。
npm install -D @commitlint/cli @commitlint/config-conventional husky
一条 commitlint.config.js 配置文件就能启用:module.exports = { extends: ['@commitlint/config-conventional'] }
四、顺手的好处
规范化的提交历史可以自动生成 CHANGELOG(semantic-release 等工具直接解析 type);feat/fix 还能驱动语义化版本号自动递增。等于把发布流程也顺手规范了。
小结
从下一次提交开始,试着把 git commit -m "fix" 改成 fix(auth): 修复 token 过期后未跳转登录页——十秒钟的事,整个仓库的历史都会因此可读。
- 点赞
- 收藏
- 关注作者
评论(0)