Commit Message Convention
一句话解释
提交信息约定是一组结构化提交信息的规则,使历史可读且可自动化。
用大白话说
提交信息约定是书写提交信息的商定风格。好的约定使 git log 可读、帮助评审者理解变更,并支持工具化(变更日志、发布说明、版本提升)。最广泛采用的是好提交信息七规则。核心规则:主题与正文用空行分隔、主题限 50 字符、主题首字母大写、主题不以句号结尾、用祈使语气("add" 而非 "added")、正文 72 字符换行、正文解释什么与为什么(而非如何)。约定式提交为自动化加 type 前缀。好的信息回答为何需要变更及做了什么,而非如何做(diff 显示如何)。"fix"、"wip"、"update" 之类坏信息在历史中无用。此处自律在每次读 git log 或 bisect bug 时回报。
示例
bash
# Good commit message
fix(parser): reject input exceeding max length
Previously the parser accepted arbitrarily long input,
which caused a stack overflow on the 1MB test case.
This adds an upfront length check and a clear error.
Closes #142
# Bad commit messages (avoid)
# fix
# wip
# updated stuff
# done主题 ≤50 字符、祈使语气、空行、正文 72 换行解释为什么。Closes #142 关联 issue。
相关术语
相关资源
相关课程
- 提交实践
学习提交约定。
解读错误信息
用大白话解释常见错误——什么意思、为什么发生、如何修复。