Skip to content
目录

git 提交规范

1. 提交信息格式

每次提交应遵循以下格式:

text
<类型>:空格<提交标志> <更新说明>

<详细描述>
<类型>:空格<提交标志> <更新说明>

<详细描述>
1
2
3

说明

类型:表示提交的类型(见类型定义)。
提交标志:明确本次更新要提交到哪个分支版本。
描述:简洁明了地说明功能或修改内容。
详细描述:可选,提供更多背景信息或注意事项。

2. 类型定义

常用类型

  • feat:新功能
  • fix:修复 bug
  • chore:空提交

不常用类型

  • docs:文档更新
  • style:格式(不影响代码运行的修改)
  • refactor:重构(即不是新增功能,也不是修复 bug 的修改)
  • perf:性能优化
  • test:添加或修改测试
  • chore:其他修改(如构建流程或辅助工具)

3. 提交标志说明:

在上传代码时,请根据以下情况添加额外的标识,以便告知代码合并人员合并代码的必要性,从而确保优质功能的合并:

  • local-:个性化功能,只适用本地分支。
  • comm-:通用功能模块或广泛存在的问题,建议合并到HIS 标准版(母版)。

4. 提交示例

普通提交

  • 类型:feat 或 fix
  • 提交标准版(母版)标志:local-
  • 描述:描述所做的功能或修复。
  • 示例
text
feat: local- 添加用户登录功能
feat: local- 添加用户登录功能
1

纯前端/后端提交到母版 - 不涉及前后端联调

  • 类型:feat 或 fix
  • 提交标准版(母版)标志:comm-
  • 描述:描述所做的功能或修复。
  • 示例
text
feat: comm- 添加用户登录功能

- 实现登录表单
- 添加验证逻辑
feat: comm- 添加用户登录功能

- 实现登录表单
- 添加验证逻辑
1
2
3
4

前后端联合更新提交到母版 - 必须同步更新的情况

  • 类型:feat 或 fix
  • 提交标准版(母版)标志:comm-h
  • 描述:描述所做的功能或修复。
  • 示例
text
feat: comm-h 实现用户资料更新功能

- 前端:添加更新表单
- 后端:实现更新 API
feat: comm-h 实现用户资料更新功能

- 前端:添加更新表单
- 后端:实现更新 API
1
2
3
4