Git Commit Message 规范

最新推荐文章于 2024-05-12 16:22:26 发布

u010020404

最新推荐文章于 2024-05-12 16:22:26 发布

阅读量538

点赞数

分类专栏： SDK项目开发&管理文章标签： git

本文链接：https://blog.csdn.net/u010020404/article/details/127413122

版权

16 篇文章 1 订阅

订阅专栏

Commit message 的作用

Commit message 都包括三个部分：Header，Body 和 Footer

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

其中，Header 是必需的，Body 和 Footer 可以省略。
不管是哪⼀个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免⾃动换⾏影响美观。

下图为是我们的某个commit实例
[Image: image.png]

**Example**
fix(mib): fix output mib type names
feat(smi): add mdio driver
docs(vlan): add vlan docs

Type⽤于说明 commit 的类别，只允许使⽤下⾯7个标识。

Scope⽤于说明 commit 影响的范围，⽐如vlan、qos、mirror等等，视项⽬不同⽽不同。

Subject是 commit ⽬的的简短描述，不超过50个字符：

Body 部分是对本次 commit 的详细描述，可以分成多⾏：

Footer是本次commit关联的jira id，方便问题追踪、回溯。例如JIRA-666

关注

专栏目录