Skip to content

Latest commit

 

History

History
127 lines (90 loc) · 2.89 KB

COMMIT_CONVENTIONS.md

File metadata and controls

127 lines (90 loc) · 2.89 KB

Git 提交说明规范

为了确保提交信息的规范性和一致性,我们遵循以下提交说明规范。请按照以下格式撰写提交信息。

提交信息格式

提交信息应包含三个部分:标题(必需)、主体(可选)和页脚(可选)。请参照以下模板:

<type>: <subject>

<body>

<footer>

1. 标题(Title)

标题简要描述此次提交的内容,长度不超过50个字符

格式:

<type>: <subject>
  • type:表示提交的类型,例如(为美观性,请在首字母使用大写):
    • Feat:新功能
    • Fix:修补 Bug
    • Docs:文档
    • Style:格式
    • Refactor:重构
    • Test:增加测试
    • Build:构建
    • Ci:持续集成
    • Chore:其他
    • Revert:回滚
    • Wip:进行中
  • subject:一句话描述本次提交的内容,简明扼要

示例:

Deat: 添加用户登录功能
Fix: 修正发票模块中的计算错误
Docs: 更新README中的安装说明

2. 主体(Body)

主体部分详细描述此次提交的内容、目的和影响。长度不限,分段书写

主体应包括:

  • 为什么:解释为什么要做这次修改,动机是什么
  • 如何:描述如何实现的
  • 什么:说明具体做了哪些修改

示例:

Feat: 添加用户登录功能

- 实现了基于JWT的登录功能
- 添加了登录表单组件
- 创建了处理登录请求的身份验证服务
- 更新了用户模型以包含身份验证令牌

3. 页脚(Footer)

页脚部分用于补充说明一些额外的信息,比如关联的任务或bug,破坏性变更等

  • 关联问题:使用关键词ClosesFixesResolves等自动关联问题
  • 破坏性变更:描述任何破坏性变更(如需要迁移、升级等)

示例:

Closes #123
BREAKING CHANGE: The user model schema has been updated, please run migrations

提交类型说明

  • Feat:新功能
  • Fix:修复 Bug
  • Docs:文档更改
  • Style:代码格式更改,不影响代码逻辑
  • Refactor:代码重构,不涉及新功能或修复bug
  • Test:添加或修改测试
  • Build:构建系统或外部依赖项的更改
  • Ci:持续集成相关更改
  • Chore:其他类型的变动
  • Revert:代码回滚
  • Wip:功能开发中

示例

以下是一些规范的提交信息示例:

Feat: 添加用户登录功能

- 实现了基于JWT的登录功能
- 添加了登录表单组件
- 创建了处理登录请求的身份验证服务
- 更新了用户模型以包含身份验证令牌

Closes #123
Fix: 修正发票模块中的计算错误

- 调整了发票总额的计算逻辑
- 添加了单元测试以覆盖新的计算逻辑

Fixes #456
Docs: 更新README中的安装说明

- 添加了逐步安装说明
- 包含了截图以提高清晰度