git commit message 格式规范

在工作中我们肯定会与git打交道。那么当你提交代码后如何让别人很快了解到你此次提交代码的改动点是哪些。此时就需要一个提交信息来描述此次提交修改的内容。没有格式的提交信息会使提交记录杂乱无章不能很快的定位哪些提交涉及代码修改哪些只是配置修改等等。而好的提交信息能使提交历史更容易阅读找到你想要的信息。这篇文章将整理 Angular 代码仓库制定的提交规范。在该格式中提交消息由三部分构成headerbodyfooter。headerBLANK LINEbodyBLANK LINEfooter在日常工作中我们一般只用headerbody与footer一般不会用但是当你需要提 PR 到别人库时会被要求写这两部分。以下是各部分职责以及格式。header 格式type(scope):shortsummary│ │ │ │ │ └─⫸Summaryin presenttense.Notcapitalized.Noperiod at the end.│ │ │ └─⫸CommitScope:common|core|packaging|service|page|component|config │ └─⫸CommitType:build|ci|docs|feat|fix|perf|refactor|style|test|deps其中type和short summary是必须要有的scope为可选字段。type 类型type用于标记此次提交的类型。feat新增功能fixbug修复docs文档相关改动style对代码的格式化改动代码逻辑并未产生任何变化refactor重构代码或者其他优化举措理论上不影响现有功能perf提升性能test新增或者修改测试用例build项目工程化方面的改动代码逻辑并未产生任何变化。包括但不限于文档代码生成等ciCI配置文件和脚本的更改deps升级依赖scopescope用于标记此次修改文件的范围。这个范围可以对应某个功能或者文件夹都可以。short summaryshort summary用于描述此次提交的内容应言简意赅。使用祈使句、现在时如应该使用change而不是changed或者changes不要大写第一个字母句末没有句号body补充short summary适当增加原因目的等相关因素用于说明更改的动机。也可以将此次提交与现有功能或代码比较说明更改的影响。footerfooter可以包含一些重大的更改信息比如非兼容性修改之类的信息需要在此描述清楚。也可以引用相关的 issue或者其他 PR 等。如 Angular 代码库的 PR 记录https://github.com/angular/angular/pulls传送门Angular Commit Message Format (https://github.com/angular/angular/blob/master/CONTRIBUTING.md)