我是怎么写 Git Commit message 的？-阿里云开发者社区

我是怎么写 Git Commit message 的？

2024-08-03 110 发布于浙江

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 我是怎么写 Git Commit message 的？

文章目录：

作用

编写格式化的 commit message 能够大大提高代码的维护效率。

比如：

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

其中，Header 是必需的，Body 和 Footer 可以省略。

type 用于说明 commit 的类别。

feature A new feature
fix A bug fix
docs Documentation only changes
style Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
refactor A code change that neither fixes a bug nor adds a feature
perf A code change that improves performance
test Adding missing tests or correcting existing tests
build Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore Other changes that don't modify src or test files
revert Reverts a previous commit

scope 用于说明 commit 影响的范围，比如数据层、控制层、视图层、具体模块等等，视项目不同而不同。

subject 是 commit 目的的简短描述，不超过50个字符。

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

BREAKING CHANGE，用来描述当前 commit 与上一个版本不兼容的地方。

Issue，用来描述当前 commit 针对的某个issue。

Commit message 和 Change log 编写指南^[1]

太教条了，太累... 给大家分享一个我使用的工具。

JetBrains IDE 插件，在 GoLand、PhpStorm 中都可以在插件市场搜索 Git Commit Message Helper。

插件地址：Git Commit Message Helper^[2]

安装后效果，在 git commit 时：

咱们看一下效果：

这时，点击 Commit 或 Commit and Push... 即可。