Commit Message 规范

最新推荐文章于 2024-07-17 05:32:34 发布

讓丄帝愛伱

最新推荐文章于 2024-07-17 05:32:34 发布

阅读量228

点赞数

CC 4.0 BY-SA版权

文章标签： git python javascript plugin 代码规范

本文介绍Angular团队的CommitMessage规范，探讨ConventionalCommitsSpecification，并演示如何编写有效、一致的提交消息，包括commit类型、scope、subject、body和footer的使用技巧。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

目前 Commit Message 规范比较常见的有 Angular 团队的规范，并由此衍生出了 Conventional Commits Specification，可以参照此 Specification 约定 Commit Message 格式规范。

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

大体分三行：
【标题行】必填, 描述主要修改类型和内容。
【主题内容】描述为什么修改, 做了什么样的修改, 以及这么做的思路等等。
【页脚注释】放 Breaking Changes 或 Closed Issues

其中 type 是 Commit 的类型，可以有以下取值

其中 scope 表示的是 Commit 影响的范围，比如 ui，utils，build 等，是一个可选内容。
其中 subject 是 Commit 的概述，body 是 Commit 的具体内容。

fix: correct minor typos in codesee the issue for details on typos fixed.Refs #133

Commit Message 可以在 git 中配置模板，这样可以在 vim 中展示出模板，另外可有工具帮助我们生成和约束 Commit Message，例如 commitizen/cz-cli