一般情况下,信息应当以少于 50 个字符(25个汉字)的单行开始且简要地描述变更,接着是一个空白行,再接着是一个更详细的解释。

    1. 首字母大写的摘要(不多于 50 个字符)
    2. 如果必要的话,加入更详细的解释文字。在大概 72 个字符的时候换行。
    3. 在某些情形下,第一行被当作一封电子邮件的标题,剩下的文本作为正文。
    4. 分隔摘要与正文的空行是必须的(除非你完全省略正文),
    5. 如果你将两者混在一起,那么类似变基等工具无法正常工作。
    6. 使用指令式的语气来编写提交信息:使用“Fix bug”而非“Fixed bug”或“Fixes bug”。
    7. 此约定与 git merge git revert 命令生成提交说明相同。
    8. 空行接着更进一步的段落。
    9. - 标号也是可以的。
    10. - 项目符号可以使用典型的连字符或星号,后跟一个空格,行之间用空行隔开,
    11. 但是可以依据不同的惯例有所不同。
    12. - 使用悬挂式缩进

    对于 commit 的类别,有 7 个标识

    • feat: 新功能(feature)
    • fix: 修补bug
    • docs: 文档(documentation)
    • style: 格式(不影响代码运行的变动)
    • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    • test: 增加测试
    • chore: 构建过程或辅助工具的变动
    • revert: 对之前修改代码 commit 记录的还原