规范化Git提交日志

把项目的git commit message规范化,对于项目的合作开发、发布等都有很大帮助。同时还能自动生成语义化的CHANGE-LOG。我们可以参考具体的标准规范化自己的提交,也可以使用辅助工具进行强制性规范。 文中使用到的工具清单: commitizen: 替代git commit cz-conventional-changelog: 符合angular规范的adapter commitlint: 校验git message husky: git hook 工具 Angular 团队规范 message 格式如下: <type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer> Message 主要分为三个部分: 标题行: 必填, 描述主要修改类型和内容 主题内容: 描述为什么修改, 做了什么样的修改, 以及开发的思路等等 页脚注释: 放 Breaking Changes 或 Closed Issues 分别由如下部分构成: type: commit 的类型 feat: 新特性 fix: 修改问题 refactor: 代码重构 docs: 文档修改 style: 代码格式修改, 注意不是 css 修改 test: 测试用例修改 chore: 其他修改, 比如构建流程, 依赖管理. scope: commit 影响的范围, 比如: route, component, utils, build… subject: commit 的概述, 建议符合 50/72 formatting body: commit 具体修改内容, 可以分为多行, 建议符合 50/72 formatting footer: 一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接....

2 min · 306 words · Johnson