如何改进 Git 提交规范

简介

对于寻求改善代码协作和项目管理的开发者而言，掌握 Git 提交规范至关重要。本全面指南将探讨创建有意义、结构化提交消息的最佳实践，这些消息可增强团队沟通、代码可追溯性以及整体软件开发工作流程。

Skills Graph

%%%%{init: {'theme':'neutral'}}%%%% flowchart RL git(("Git")) -.-> git/BasicOperationsGroup(["Basic Operations"]) git(("Git")) -.-> git/DataManagementGroup(["Data Management"]) git(("Git")) -.-> git/BranchManagementGroup(["Branch Management"]) git/BasicOperationsGroup -.-> git/status("Check Status") git/BasicOperationsGroup -.-> git/commit("Create Commit") git/BasicOperationsGroup -.-> git/diff("Compare Changes") git/DataManagementGroup -.-> git/reset("Undo Changes") git/BranchManagementGroup -.-> git/log("Show Commits") git/BranchManagementGroup -.-> git/cherry_pick("Cherry Pick") git/BranchManagementGroup -.-> git/rebase("Reapply Commits") subgraph Lab Skills git/status -.-> lab-451802{{"如何改进 Git 提交规范"}} git/commit -.-> lab-451802{{"如何改进 Git 提交规范"}} git/diff -.-> lab-451802{{"如何改进 Git 提交规范"}} git/reset -.-> lab-451802{{"如何改进 Git 提交规范"}} git/log -.-> lab-451802{{"如何改进 Git 提交规范"}} git/cherry_pick -.-> lab-451802{{"如何改进 Git 提交规范"}} git/rebase -.-> lab-451802{{"如何改进 Git 提交规范"}} end

提交消息基础

什么是 Git 提交消息？

Git 提交消息是对特定提交中所做更改的描述。它作为一份历史记录，帮助开发者理解代码修改的目的和背景。精心编写的提交消息对于维护清晰且易于理解的项目历史至关重要。

优秀提交消息的剖析

一条典型的提交消息由三个主要部分组成：

1. 提交标题（主题行）

标题应：

简洁（50 个字符或更少）
具有描述性
用祈使语气书写

2. 提交正文（可选）

提供有关更改的更多上下文和解释：

与标题之间用空行隔开
每行限制在 72 个字符以内
解释做了什么以及为什么，而非如何做

3. 页脚（可选）

包含额外的元数据，如：

问题引用
重大更改
“Signed-off-by”信息

基本提交消息结构

graph TD A[提交标题：简短、清晰的描述] --> B{可选正文} B -->|详细解释| C[提供上下文和理由] B -->|可选| D[带有额外信息的页脚]

优秀提交消息示例

## 结构良好的提交消息示例
git commit -m "添加用户认证模块

- 实现登录功能
- 创建用户注册流程
- 添加密码加密机制

解决 #123"

常见提交消息约定

约定	描述	示例
祈使语气	使用现在时态	“添加功能”而非“已添加功能”
大写	首字母大写	“修复漏洞”而非“fix bug”
无句号	避免主题行以句号结尾	“更新 README”而非“更新 README.”

最佳实践

具体且简洁
使用祈使语气
解释更改的动机
适当时引用问题编号
用空行分隔主题和正文

给 LabEx 开发者的实用提示

在 LabEx 环境中处理项目时，始终努力创建有意义的提交消息，清晰传达你所做更改的目的。一条好的提交消息可以在代码审查期间节省时间，并有助于团队协作。

编写有效的提交

提交粒度

理解原子提交

原子提交表示代码库中的一个单一、逻辑上的更改。关键原则包括：

graph TD A[原子提交] --> B[单一职责] A --> C[最小化且专注] A --> D[易于撤销]

提交大小指南

提交大小	特点	建议
过小	零碎的更改	合并相关更改
最佳	专注、单一目的	首选方法
过大	多个不相关的更改	拆分为更小的提交

提交消息撰写技巧

1. 使用祈使语气

## 好的提交消息
git commit -m "添加用户认证服务"

## 避免
git commit -m "已添加用户认证服务"

2. 提供上下文和动机

git commit -m "实现密码重置功能

- 添加密码重置端点
- 创建验证机制
- 通过实施速率限制增强安全性

解决用户认证过程中的安全漏洞"

高级提交策略

暂存部分更改

## 暂存文件的特定部分
git add -p filename.py

交互式暂存

## 交互式选择要提交的更改
git add -i

提交消息模板

创建一个全局提交模板：

## 设置提交模板
git config --global commit.template ~/.gitmessage

示例模板：

## [类型]：简短描述

## 为什么此更改是必要的？
## 它解决了什么问题？
## 实现细节是什么？

## 解决：#问题编号

常见提交类型

类型	目的	示例
feat	新功能	添加用户注册模块
fix	修复漏洞	解决认证错误
docs	文档更新	使用设置说明更新 README
refactor	代码重构	优化数据库查询性能
test	添加/修改测试	为登录服务添加单元测试

给 LabEx 开发者的最佳实践

频繁提交
保持提交专注
编写清晰、有描述性的消息
提交前审查更改
有效使用暂存区

提交工作流程可视化

要避免的常见错误

提交不相关的更改
编写模糊的提交消息
忽略代码审查指南
跳过提交前检查

高级提交策略

交互式变基

理解交互式变基

交互式变基允许你在推送到共享仓库之前修改提交历史记录：

## 对最后3次提交开始交互式变基
git rebase -i HEAD~3

graph TD A[原始提交历史记录] --> B[交互式变基] B --> C[重新排序提交] B --> D[压缩提交] B --> E[编辑提交消息]

变基操作

操作	描述	示例
pick	按原样使用提交	默认操作
reword	修改提交消息	更改描述
squash	合并提交	合并多个提交
fixup	合并提交，丢弃消息	清理历史记录
drop	删除提交	删除不必要的提交

提交签名

GPG密钥设置

## 生成GPG密钥
gpg --full-generate-key

## 配置Git以使用GPG
git config --global user.signingkey YOUR_GPG_KEY
git config --global commit.gpgsign true

语义化提交消息

规范提交标准

graph LR A[类型] --> B[可选范围] B --> C[描述性消息] C --> D[可选的重大更改]

提交类型示例

类型	描述	示例
feat	新功能	feat(auth): 添加双因素认证
fix	修复漏洞	fix(database): 解决连接泄漏问题
docs	文档	docs(readme): 更新安装指南
refactor	代码重构	refactor(api): 简化错误处理
test	与测试相关的更改	test(user): 添加登录验证测试

高级暂存技术

部分暂存

## 暂存文件的特定块
git add -p filename.py

存储更改

## 临时存储未提交的更改
git stash save "进行中的工作"

## 列出存储的更改
git stash list

## 应用最新的存储
git stash apply

提交钩子

提交前验证

## 示例提交前钩子脚本
#!/bin/bash
## 验证代码风格
npm run lint
## 运行测试
npm test

LabEx项目的提交最佳实践

使用原子提交
编写描述性消息
为提交签名以确保真实性
遵循语义化提交规范
利用交互式变基

提交工作流程可视化

高级Git配置

## 全局Git配置
git config --global alias.co checkout
git config --global alias.br branch
git config --global alias.lg "log --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --graph"

错误处理与恢复

从错误中恢复

## 撤销上一次提交，保留更改
git reset --soft HEAD~1

## 完全删除上一次提交
git reset --hard HEAD~1

总结

通过实施完善的Git提交规范，开发者可以转变他们的版本控制方式，创建更具可读性、信息丰富且有价值的提交历史记录。本教程中概述的策略提供了一种系统的方法来记录代码更改，促进更好的团队协作和长期的项目维护。