规范系列之代码提交日志

“规范”是一种秩序，是代码世界中的秩序，而工程师们就是这些秩序的缔造者。

一、规范的目标

在生产代码的过程，当工程师编写完一段代码之后，需要将代码提交到代码仓库，这时候工程师会针对本次提交动作写上相关的文字描述，以便其他工程师粗略判断你此次做了什么事情。这里我们要规范的就是如何写提交描述或者说提交日志。

二、要不要规范

• 规范的日志能够让人在不阅读代码的情况下了解到该代码的大致作用和作用范围
• 规范的日志便于统计分析
• 规范的日志便于代码追溯
• ....

你说要不要规范？

• 代码基于Git管理
• 团队拥有规范动机

三、怎么规范

1、约定：团队达成共识，口头约定按照某种形式编写提交日志。

        缺点：难以确保每个人按预期执行

2、工具：团队可以自研或者使用开源的工具，使用工具进行强制按设置进行编写提交日志。

        缺点：学习成本（开源工具）；研发成本（自研工具）

四、用例

 commitlint+husky

• commitlint：一种分析commit message内容的工具，能够帮助我们分析编写的提交信息是否符合指定的规范：type(scope?): subject。官网
• husky：一种帮助我们更好使用Git Hooks的工具。官网

详见代码实例