Git Commit 提交规范

jetsung

Git Commit 提交规范是一种通用的约定，旨在提高 Git 仓库的可读性和可维护性。这种约定通常包括以下内容：

Type（类型）：用于说明本次提交的类型，是新增功能、修复 Bug 还是重构代码等。通常使用以下几种：

feat: 新功能（feature）的添加或修改。

fix: 修复 bug。

chore: 与构建过程或辅助工具相关的变动。

docs: 文档相关的变动。

style: 代码样式（不影响功能）的变动，如空格、格式化等。

refactor: 代码重构，既不修复错误也不添加功能。

test: 测试相关的变动。

perf: 性能优化的变动。

build: 构建系统或外部依赖的修改。

ci: CI/CD 相关的变动。

Scope（范围）：用于说明本次提交涉及的范围，比如某个文件、某个模块等。
Subject（摘要）：用于简要说明本次提交的内容，不超过 50 个字符。通常使用动词原型开头，比如“新增了”、“修复了”、“修改了”等。
Body（正文）：用于详细说明本次提交的内容。可以包含原因、解决方案、注意事项等。一般应该使用多行描述，每行不超过 72 个字符，可以使用 Markdown 语法进行格式化。
Footer（尾部）：用于关联相关 Issue 或 Pull Request。可以使用一些特定的关键字，比如“Fixes”、“Closes”等，后面跟上 Issue 或 Pull Request 的号码。

一个符合规范的 Git Commit 提交示例：

feat(auth): 新增了 Google 账号登录功能

为了增加用户登录的便捷性，新增了使用 Google 账号登录的功能。主要完成了以下工作：

- 在 Auth 模块中新增了 GoogleAuth 类
- 在 Login 模块中添加了 Google 登录按钮
- 在 README.md 中更新了相关文档

Fixes #123

jetsung

提交消息的规范是一种良好的实践，可以帮助团队成员更好地理解和回顾代码库的历史记录。下面是一种常见的提交消息规范，称为约定式提交（Conventional Commits）：

每个提交消息由三个部分组成：标题、正文和脚注。它们之间使用空行分隔。

标题（Header）：
- 标题是提交消息的概要，应该简明扼要地描述所做的更改。
- 使用动词的现在时态，以及第一人称或第三人称单数。例如："Fix", "Add", "Update"等。
- 标题应该具有清晰的意义，能够独立理解提交所做的更改。
- 尽量避免使用过长的标题，一般不超过50个字符。
正文（Body）：
- 正文是对提交的详细描述，可选项。
- 正文可以包含更详细的信息，例如所解决的问题、修改的原因、引入的新功能等。
- 正文应该使用简洁的语言，并尽量遵循段落结构。
脚注（Footer）：
- 脚注是可选的，用于提供额外的元数据或与其他系统的集成。
- 常见的用法是引用相关的问题或任务，例如使用"Fixes #123"或"Closes #456"来自动关闭问题或任务。

下面是一个示例的提交消息：

Add login form component

- Created a new component for the login form.
- Implemented input validation and error handling.
- Added styling for the form elements.

Fixes #123

使用这种约定式提交规范，可以帮助团队更好地跟踪和管理代码库的历史记录，使得提交消息更加一致和易于理解。当浏览提交历史或进行版本回退时，规范的提交消息能够提供更多的上下文信息。

jetsung

如果你使用中文作为提交消息的语言，可以采用类似的前缀标识来组织提交的类型。以下是一种常见的中文提交消息前缀示例：

新功能：添加新功能或进行功能修改。例如："新功能：添加用户注册功能"
修复：修复 bug。例如："修复：修复登录表单验证问题"
构建：与构建过程或辅助工具相关的变动。例如："构建：更新构建脚本"
文档：文档相关的变动。例如："文档：更新使用指南"
样式：代码样式（不影响功能）的变动，如空格、格式化等。例如："样式：调整代码缩进"
重构：代码重构，既不修复错误也不添加功能。例如："重构：优化用户权限验证逻辑"
测试：测试相关的变动。例如："测试：添加用户注册表单测试"
性能：性能优化的变动。例如："性能：优化数据库查询速度"
构建：构建系统或外部依赖的修改。例如："构建：升级第三方库版本"
CI/CD：与 CI/CD 相关的变动。例如："CI/CD：更新持续集成配置"

使用这种中文提交消息前缀的方式可以帮助团队更好地组织和理解提交历史。不论是使用英文还是中文，关键是在团队中达成一致，并按照一致的规范书写提交消息。这样可以提高代码库的可维护性和协作效率。

jetsung

Git 提交规范在团队协作中至关重要，可以帮助提高代码提交的可读性和维护性。以下是符合 中文语境 的 Git 提交规范，参考了 Angular 的提交信息规范，适合在开发流程中使用。

1. 提交信息格式

<类型>(<模块>): <简要说明>

<详细描述>（可选）
<关联的任务或工单号>（可选）

示例

feat(用户管理): 新增用户角色管理功能

- 支持新增和删除角色
- 优化角色权限展示逻辑

关闭 #123

2. 提交类型

常用的提交类型包括以下几种：

类型	描述
feat	新功能、新特性
fix	修复 bug
docs	文档更新或补充
style	代码格式修改（无功能性改动）
refactor	代码重构（不影响功能和修复）
perf	性能优化
test	添加或修改测试用例
chore	其他修改（构建、依赖管理等）
revert	撤销之前的提交
build	构建系统或外部依赖的更改
ci	持续集成相关修改

3. 提交信息规范

3.1 第一行：简要描述

限制在 50 字以内，尽量简洁明了。
开头必须是一个 提交类型，并在后面加括号说明模块（可选）。
简要说明用中文，尽量保持句子通顺，但不用加句号。

例子：

fix(登录模块): 修复输入密码时无法显示光标的问题

3.2 第二行空一行

3.3 第三行：详细描述（可选）

详细描述补充第一行内容，解释为什么修改、做了什么修改，包括解决方案或动机。
可多行描述，每行 72 字以内。

例子：

- 修复光标消失问题，原因是 CSS 样式覆盖了 input 输入框的默认样式
- 调整样式规则，确保输入框聚焦时光标可见

3.4 第四行：关联任务号或工单号（可选）

如果提交和某个任务或 Bug 关联，可以写上对应的任务号。
使用 关闭、关联 等关键词。

例子：

关闭 #123
关联任务: PROJ-456

4. 提交信息注意事项

中文描述：所有提交信息均使用中文，确保易于理解。
动词使用：使用动词原形，例如“修复”、“新增”、“优化”，保持格式统一。
明确目的：提交信息要尽量描述清楚做了什么改动 和 为什么。
小步提交：尽量把提交拆分为小而清晰的单元，便于代码审查。

5. 实践示例

示例 1：功能开发

feat(支付模块): 新增支付宝支付功能

- 支持用户选择支付宝支付
- 添加支付结果回调接口

关联任务: PAY-789

示例 2：修复 Bug

fix(订单管理): 修复订单导出失败的问题

- 导出订单时处理数据量过大的情况
- 优化数据分页逻辑

关闭 #456

示例 3：文档更新

docs(README): 更新项目启动步骤

- 添加本地环境的配置说明
- 补充常见错误的解决方案

示例 4：代码优化

refactor(用户管理): 重构用户列表查询逻辑

- 将查询逻辑抽离为独立服务
- 提高代码可复用性和可维护性

通过以上规范，团队成员可以更清晰地了解每次提交的内容、原因和影响，从而提高协作效率。