git commit 提交规范

在软件开发中，良好的Git提交记录规范有助于保持代码库的清晰和易维护。常见的提交记录规范之一是由Angular团队提出的Conventional Commits，它提供了一种结构化的提交消息格式，便于自动化工具处理和生成变更日志。

Conventional Commits规范

Conventional Commits的提交消息由以下部分组成：

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

1. 类型（Type）

type用于说明提交的类型。常见的类型包括：

• feat：新功能（feature）
• fix：修补bug
• docs：文档变更
• style：代码格式（不影响代码运行的变动）
• refactor：重构（既不是新增功能，也不是修复bug的代码变动）
• perf：优化相关，比如提升性能、体验
• test：增加测试
• build：构建系统或外部依赖项的变更
• ci：CI配置文件及脚本的变更
• chore：其他不修改src或test文件的变动
• revert：恢复先前的提交

2. 可选范围（Scope）

scope是可选的，用于说明提交影响的范围，比如数据层、控制层、视图层等。

3. 描述（Description）

description是对变更的简要说明，应该简明扼要。

4. 可选主体（Body）

body是可选的，详细描述提交的内容，可以包括变更的动机和设计细节。

5. 可选页脚（Footers）

footer是可选的，用于放置与提交相关的元数据，例如关闭的issue或破坏性变更的说明。

示例

1. 添加新功能

feat(user): add user authentication

Implemented user authentication using JWT. Added login and signup endpoints.

2. 修复bug

fix(login): resolve login issue with special characters

Fixed a bug where users could not log in if their password contained special characters.

3. 文档变更

docs(readme): update installation instructions

Updated the README file to include new installation steps for Windows users.

4. 代码格式变更

style: format code with Prettier

Applied Prettier formatting to the entire codebase to ensure consistent code style.

5. 重构代码

refactor(auth): simplify authentication middleware

Refactored the authentication middleware to reduce complexity and improve readability.

6. 性能优化

perf(database): optimize query performance

Improved database query performance by adding appropriate indexes.

7. 测试

test(auth): add unit tests for authentication

Added unit tests for the authentication service to cover all edge cases.

8. 构建系统变更

build(deps): update dependency lodash to v4.17.21

Updated the lodash dependency to address a security vulnerability.

9. CI配置变更

ci(travis): add Node.js version 14 to build matrix

Configured Travis CI to test against Node.js version 14.

10. 其他杂项

chore: update contributors list

Updated the CONTRIBUTORS.md file to include new contributors.

11. 恢复先前的提交

revert: revert "feat: add user authentication"

This reverts commit abc123.

使用工具自动化

为了确保提交记录符合规范，可以使用工具进行自动化验证和格式化。例如：

• Commitizen：交互式CLI工具，帮助生成符合Conventional Commits规范的提交消息。
• Commitlint：验证提交消息是否符合规范的工具。
• Husky：Git钩子管理工具，可以与Commitlint结合使用，在提交前进行验证。

Commitizen示例

安装Commitizen和Conventional Commits适配器：

npm install -g commitizen
commitizen init cz-conventional-changelog --save-dev --save-exact

使用Commitizen进行提交：

git cz

Commitlint和Husky示例

安装Commitlint和Husky：

npm install @commitlint/{config-conventional,cli} husky --save-dev

配置Commitlint：

echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js

设置Husky Git钩子：

npx husky install
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

通过这些工具，可以确保团队成员在提交代码时遵循统一的提交记录规范，保持代码库的整洁和可维护性。