首页/开发/Git 与协作速查/提交信息结构与多段写法
Git 基础与命令88 条

提交信息结构与多段写法

提交信息约定:首行主题句、空行、正文说明动机;可用多个 -m 拼段落,或用 -F 从文件读取,-v 在编辑器中附带 diff 预览。

Git 与协作速查开发更新于 2026-10-12
结构主题行 / 空行 / 正文 /(可选)footer
多段多个 -m 依次拼接
从文件git commit -F msg.txt

常用示例

常用示例
git commit -m 'fix(api): handle empty response' -m 'Retry once on 502; add regression test.'
git commit -F msg.txt
git log -1 --format=%B
主题行说明「做了什么」,正文说明「为什么这么做」;把评审者关心的问题写清楚,比复述 diff 有价值。

易错点

  • 主题行过长会在平台上被截断显示,建议控制在 50 字符左右
  • 引用 issue 编号放 footer(如 Refs #123)便于平台自动关联,混在主题里反而不被识别

数据来源与参考

  • Pro Git 2nd Edition · 5.2 维护项目(提交信息规范建议)
  • Conventional Commits 1.0.0(conventionalcommits.org)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌