在现代软件开发中,良好的 Git 提交信息不仅有助于项目协作、问题追踪和历史回溯,更是保障项目可维护性的重要一环。本文将基于 AngularJS 团队广泛使用的 Git 提交信息规范,手把手教你如何写出专业、统一、可读性强的 commit message。
遵守统一的提交规范可以带来以下好处:
git bisect
调试时可跳过不相关提交标准的 Git 提交信息应遵循以下格式:
():
⚠️ 每一行 建议不超过 100 个字符,以便在 Git 工具或 GitHub 等平台中更好地展示。
格式如下:
():
type
:说明 commit 的类型(详见下文)scope
:可选,说明 commit 影响的范围(如模块、组件等)subject
:简洁明了地描述本次修改内容(动词开头、小写、无句号)示例:
feat(router): add lazy-loading support
fix(login): prevent crash on invalid credentials
docs(api): update user guide for v2 endpoints
下面是推荐的类型(type)及其用途说明:
Type | 用途 |
---|---|
feat |
新功能 |
fix |
修复 Bug |
docs |
文档变更 |
style |
格式修改(不影响逻辑,例如空格、分号等) |
refactor |
代码重构(不是新功能,也不是 Bug 修复) |
test |
增加测试或修改现有测试 |
chore |
构建流程、工具等杂项维护 |
revert |
回滚某次提交 |
scope
是对变更影响模块的说明,例如:
$http
, $compile
, auth
, router
ngClick
, form
, login-page
没有明确 scope 时,可以使用 *
代替:
chore(*): update all dependencies
这是 commit 的简要描述:
✅ 正确示例:
add support for dark mode
❌ 错误示例:
Added support for dark mode.
正文用于说明提交的 动机、前后行为对比 或 技术细节。规范要求:
示例:
Old behavior did not support lazy loading,
which caused bundle size to be large on initial load.
This commit introduces a dynamic import-based strategy
to only load modules when needed.
页脚用于列出:
使用 BREAKING CHANGE:
开头,说明该变更会破坏兼容性,并附上迁移建议:
BREAKING CHANGE: remove deprecated `authToken` param
Use `accessToken` instead and update middleware config accordingly.
通过 Closes #123
形式自动关闭对应 Issue:
Closes #123, #456
如果需要撤销某次提交,格式如下:
revert: feat(router): add lazy-loading support
This reverts commit e7a8db27f2d8deac3c8e2731ffb33f.
以下是一些完整的 commit message 示例,供参考:
feat($browser): onUrlChange event (popstate/hashchange/polling)
Added new event to $browser:
- forward popstate event if available
- fallback to hashchange
- finally use polling if no event is supported
BREAKING CHANGE: removed $browser.onHashChange
Closes #128
fix($compile): fix HTML serialization in IE9
Older IE versions serialize HTML in uppercase, but IE9 does not.
Case-insensitive comparison is required, but jasmine lacks support.
Closes #392
docs(guide): fix typos in directive guide
- correct batchLogbatchLog -> batchLog
- fix indentation and braces
git log <last-tag> HEAD --pretty=format:"%s"
git log <last-tag> HEAD --grep feat
git bisect skip $(git rev-list --grep irrelevant <good-commit> HEAD)
一个优秀的提交信息应当是:
如果你想让你的团队协作更顺畅,让开源项目更专业,从写好每一个 commit message 开始吧!