如何规范自己的git提交信息?了解规范,使用规范。

77 阅读1分钟

很多时候,我们提交的git信息都是随便写一段,有时候就很混乱,后期来看也要花很长时间来确定具体做了什么东西,这会浪费我们很多时间。

这时候,我们就需要一套规范的提交信息,来帮助我们快速了解提交的内容。

首先我们git提交的时候,尽量小的提交,完成一个功能或者模块就可以提交。

提交的时候,信息格式安装下面的格式编辑。

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

其中:

<type>: 必须,表示提交的类型,例如:

feat: 新功能(feature)
fix: 修复bug
docs: 文档修改
style: 代码样式调整(不影响代码逻辑)
refactor: 代码重构(既不修复bug也不添加新功能)
perf: 性能优化
test: 测试代码的增加或修改
build: 构建过程或辅助工具的更改
chore: 其他变动(如配置文件、依赖库更新等)
revert: 回滚到先前的提交

<scope>: 可选,表示更改影响的范围或组件,如ui、database等,用于提供更多的上下文信息。
<subject>: 必须,简洁明了的描述,通常是一句完整的句子,说明这次提交做了什么。
<body>: 可选,提供关于这次提交的详细信息,解释原因和实现细节。
<footer>: 可选,通常包含关闭的issue编号,如Closes #123,或相关链接。

例如,一个完整的提交信息可能如下所示:

fix(parser): Handle empty input gracefully
When no input is provided, the parser now returns an error instead of crashing.

The previous behavior could lead to unhandled exceptions in production.
This commit introduces a safeguard to handle empty input and return a descriptive error message.

Closes #25