Git Commit Message 的最佳实践

在 Git 中，一个好的 commit message 应该清晰、简洁，并能准确描述本次提交的内容。良好的 commit 规范有助于团队协作、代码审查（Code Review）以及后续的版本维护。以下是 Git Commit Message 的最佳实践：

1. Commit Message 结构
推荐采用 Conventional Commits 规范，格式如下：

1
2
3
4
5

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

1
2
3
4
5
6
7
8
9
10
11
12

feat(auth): add user login API

- Implement JWT-based authentication
- Add login endpoint `/api/auth/login`
- Update README with API docs

fix: resolve memory leak in image processing

The previous implementation caused OOM errors when processing large images.
This fix uses a streaming approach to reduce memory usage.

BREAKING CHANGE: The `processImage` function now requires a callback.

2. Commit Message 各部分说明

3. 常见 Commit Type 示例

4. 不好的 Commit Message 示例
❌ 模糊不清

1
2

update code
fix bug

1
2

fix(auth): correct login validation error
feat(api): add user registration endpoint

❌ 缺少类型

1

add new feature

1

feat: implement user profile page

❌ 过于冗长

1

this commit adds a new feature that allows users to log in and also fixes some minor bugs in the process

1
2

feat: add user login API  
fix: resolve minor UI alignment issues

5. 如何规范 Commit Message？
(1) 使用 Git Hooks（推荐）
• Husky + commitlint（强制检查 Commit 格式）

1
2
3
4
5

npm install husky --save-dev
npx husky-init && npm install
npm install @commitlint/{config-conventional,cli} --save-dev
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

这样提交时如果不符合规范会被阻止。

(2) 使用 Commitizen（交互式提交）

1
2

npm install -g commitizen
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

6. 总结
✅ 好的 Commit Message 应该：
• 简洁明了，准确描述变更内容

• 遵循 <type>: <description> 格式

• 关键变更可加 BREAKING CHANGE 或关联 Issue

• 使用工具（Husky + commitlint）强制规范

这样可以让团队协作更高效，代码历史更清晰！ 🚀

在 Git 中，一个好的 commit message 应该清晰、简洁，并能准确描述本次提交的内容。良好的 commit 规范有助于团队协作、代码审查（Code Review）以及后续的版本维护。以下是 Git Commit Message 的最佳实践：

1. Commit Message 结构
推荐采用 Conventional Commits 规范，格式如下：

1
2
3
4
5

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

1
2
3
4
5
6
7
8
9
10
11
12

feat(auth): add user login API

- Implement JWT-based authentication
- Add login endpoint `/api/auth/login`
- Update README with API docs

fix: resolve memory leak in image processing

The previous implementation caused OOM errors when processing large images.
This fix uses a streaming approach to reduce memory usage.

BREAKING CHANGE: The `processImage` function now requires a callback.

2. Commit Message 各部分说明

3. 常见 Commit Type 示例

4. 不好的 Commit Message 示例
❌ 模糊不清

1
2

update code
fix bug

1
2

fix(auth): correct login validation error
feat(api): add user registration endpoint

❌ 缺少类型

1

add new feature

1

feat: implement user profile page

❌ 过于冗长

1

this commit adds a new feature that allows users to log in and also fixes some minor bugs in the process

1
2

feat: add user login API  
fix: resolve minor UI alignment issues

5. 如何规范 Commit Message？
(1) 使用 Git Hooks（推荐）
• Husky + commitlint（强制检查 Commit 格式）

1
2
3
4
5

npm install husky --save-dev
npx husky-init && npm install
npm install @commitlint/{config-conventional,cli} --save-dev
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

这样提交时如果不符合规范会被阻止。

(2) 使用 Commitizen（交互式提交）

1
2

npm install -g commitizen
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

6. 总结
✅ 好的 Commit Message 应该：
• 简洁明了，准确描述变更内容

• 遵循 <type>: <description> 格式

• 关键变更可加 BREAKING CHANGE 或关联 Issue

• 使用工具（Husky + commitlint）强制规范

这样可以让团队协作更高效，代码历史更清晰！ 🚀