GitConventionalCommits

Conventional Commits规范是一种用于编写清晰、标准化的提交信息的约定。它有助于自动化工具解析提交历史,生成版本日志和管理版本号。以下是该规范的一些关键点:

根据GitConventialCommits规范,git的提交信息可以简单写成:

1
2
3
4
5
<type>[optional scope]: <description>

[optional body]

[optional footer(s)]
  • type: 提交的类型,常见的有:

    • feat: 新功能
    • fix: 修复bug
    • docs: 文档更新
    • style: 代码格式(不影响代码运行的变动)
    • refactor: 重构代码(既不是新增功能也不是修复bug)
    • test: 添加或修改测试
    • chore: 构建过程或辅助工具的变动
  • scope: 可选项,表示影响的范围,如模块或文件名。

  • description: 简要描述提交的目的。

示例

1
2
3
4
feat(auth): add login functionality
fix(api): correct endpoint URL
docs(readme): update installation instructions
style(css): format header styles

额外信息

  • BREAKING CHANGE: 如果有重大变更,可以在正文中注明。
  • Footer: 可以包含任何与提交相关的元信息,比如关闭的issue。

这种规范化的提交信息有助于提高项目的可维护性和协作效率。


GitConventionalCommits
https://20040702.xyz/2025/02/19/git-commit-msg/
作者
Seeker
发布于
2025年2月19日
许可协议