用途
Commit Messages 用于在编写、审查或编辑 Git 提交信息时提供写作规范,目标是让提交信息清晰、简洁,使读者一眼就能理解变更意图。
主要能力
- 提供主题行写作规则:软上限 160 字符,越短越好;使用祈使语气(如“Add feature”而非“Added”或“Adds”);首字母大写;结尾不加句号;概括变更而非过程。
- 要求主题与正文之间空一行,便于工具正确解析;若主题已足够说明,可省略正文。
- 规定正文写法:每行约 72 字符换行;解释“为什么”而非“做了什么”;说明约束或决策;使用 Fixes #123 或 Refs #456 引用议题。
- 强调一次提交只包含一个逻辑变更;若描述需要用“and”连接,通常应拆分为两次提交。
- 明确应包含的内容:高层级变更说明、变更原因(尤其是正文)、破坏性变更或迁移说明、相关议题引用。
- 明确不应包含的内容:文件列表、模糊描述(如“fix bug”“update stuff”“WIP”)、多个不相关变更、实现细节(差异已展示“怎么做”,信息应解释“为什么”)。
- 列出常见误区:模糊主题、过去时、主题过长被截断、主题后缺少空行、巨型提交、在信息正文粘贴代码或差异。
- 提供写后验证清单:主题是否少于 160 字符并概括变更、是否使用祈使语气、主题后是否有空行、正文是否解释原因、是否只含一个逻辑变更、能否拆分为更小提交。
使用方式
在编写新变更的提交信息、压缩或变基提交、审查提交信息清晰度时使用。按指南撰写主题与正文,并对照自查清单逐项确认。
适用场景
适用于日常 Git 提交信息撰写、提交历史整理(压缩/变基)、代码审查中对提交信息的检查。
限制
不适用于标签信息、自动化工具生成的合并提交信息、变更日志条目。