Git commit message 编写风格

仅限个人与 The S/L Studio使用，除此之外仅供参考。

格式

Header

type 用于说明 commit 的类别，subject是 commit 目的的简短描述，不超过50个字符。

Debug(Fix)

Fix: bugID(issue#ID) or summary

e.g.
Fix: issue[#123] why The Null is so niubility

修复 bug ，且不影响其功能实现。

新特性实现(Feat)

e.g.
Feat: 128-core CPU optimization

重构(Refactor)

e.g.
Refactor: remove codes which sb wrote

小改动(Modified)

算不上debug、refactor的小改动。

e.g.
Modified: add comments

文档(Docs)

修改文档。

其它

  • 每个提交都必须使用 type 字段前缀，它由一个名词组成，诸如 feat 或 fix ，其后接一个可选的作用域字段，以及一个必要的冒号（英文半角）和空格

  • 中文与英文之间空一格

  • 末尾不加标点

  • 一个改动，一个 commit ，不要积累

  • Header 是必须的，Body 和 Footer 可以省略

文章目录