Git 样式指南

提交说明 commit messages

Tip

提交说明 commit messages 对于解释你为什么要这样修改代码至关重要。不仅供同事或协作者查看,还供你自己将来查看

格式

md
类型:主题
正文
脚注
  • 类型 提示该次提交代码的主要功能,常见类型:
    • feature 新功能
    • fix 错误修复
    • docs 文档修改
    • style 格式、分号缺失等,代码无变动
    • refactor 生产代码重构
    • test 测试添加、测试重构等,生产代码无变动
    • chore 构建任务更新、程序包管理器配置等,生产代码无变动
  • 主题 简要说明更改的内容。不应超过 50 个字符,首字母大写,不以句点结尾。不建议使用“修复”或“执行了某些操作”这类字眼
  • 正文 更详细地描述你进行更改的原因。每行通常包含 72 个字符左右(确保在命令行上使用 git 时,能够在终端窗口中显示出来)。确保主题和正文之间有一个空行。当需要创建列表时,也可以使用星号 * 或短横线 - 添加项目符号。有些提交的说明中不需要正文。例如,如果更正一个拼写错误,可以只有一个主题行。
  • 脚注 通常用于指示此提交解决哪些问题或错误
md
feature: 用 50 个或更少字符总结改动
如有必要,提供更详细的阐释文本。将其限制在 72 个字符左右。
有些情况下,第一行被视为提交的主题,其余文本被视为正文。
将摘要与正文分隔开的空行至关重要(除非你完全省略正文);如果不分隔摘要和正文,会使 `log``shortlog``rebase` 等工具可能无法识别。
解释此次提交要解决的问题。
重点是为什么要进行此次改动而不是如何改动(代码会说明这一点)。
此次改动是否有任何副作用或其他不太直观的后果?可在此处解释这些方面。
空行后面可以有更多段落。
  - 还可以使用项目符号分项列出
  - 通常使用连字符或星号作为项目符号,前面有一个空格,中间是一些空行,但惯例不尽相同
如果你使用问题跟踪器,请在底部提供对问题的引用,
例如:
解决:# 123
另请参见:# 456、# 789
Tip

如果你从事的是一个开源项目,请务必遵守该项目的说明格式。这会让维护者的工作更轻松,并增加你的合并请求被接受的机会。


Copyright © 2024 Ben

Theme BlogiNote

Icons from Icônes