首页/开发/Git 与协作速查/提交页脚与关联信息
协作与代码评审75 条

提交页脚与关联信息

页脚用于附加机器可读信息:BREAKING CHANGE、引用 Issue(Refs、Closes)与其他 trailer;token 中的空格用连字符替代。

Git 与协作速查开发更新于 2026-10-12
格式token: value 或 token #value,一行一个
token 规则空格用 - 替代(如 Acked-by),BREAKING CHANGE 例外
常见用途关联需求单、声明破坏性变更、记录协作者

多段提交信息示例

多段提交信息示例
git commit -m 'fix(login): 修复重定向循环' -m 'Closes #4821' -m 'Refs: PROJ-231'

查看页脚

查看页脚
git log -1 --format='%B'
git log --grep 'Closes #4821' --oneline
页脚单独成段(正文与页脚之间保留空行),解析工具按段落识别;不要把它塞进正文里。

易错点

  • 页脚与正文之间缺空行时会被当作正文,自动化关联失效
  • 在页脚写内部链接或凭证信息会在公开发布时泄露,公开仓库提交前先脱敏

数据来源与参考

  • Conventional Commits 1.0.0 规范(footer 章节)
  • Git 官方文档:git-interpret-trailers
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌