怎样记录Patch补丁变更

记录 Patch（补丁）变更，核心目标是可追溯、可复现、可回滚。下面按“规范做法 → 实际工具 → 模板示例”给你一套可落地的方案。

一、Patch 变更记录应包含什么

一个合格的 Patch 变更记录通常包含：

1. 基本信息

   • Patch 编号 / 名称
   • 适用版本（如 v1.2.0）
   • 创建人 / 负责人
   • 创建日期

2. 变更原因

   • Bug 编号（Jira / GitHub Issue）
   • 安全风险
   • 性能问题

3. 变更内容

   • 修改文件清单
   • 函数 / 模块级别说明
   • 配置项变更

4. 影响范围

   • 受影响功能
   • 是否兼容旧版本
   • 是否需数据库变更

5. 验证方式

   • 单元测试
   • 回归测试
   • 验收标准

6. 部署与回滚

   • 部署步骤
   • 回滚方案
   • 责任人

二、常见记录方式（按团队规模）

1️⃣ 轻量型：CHANGELOG + Patch 文件

适合小团队或个人项目

patches/
  2026-01-15-fix-login-timeout.patch
CHANGELOG.md

CHANGELOG.md 示例

## [1.2.1] - 2026-01-15
### Fixed
- 修复登录超时未跳转问题 (#123)
- 补丁文件：patches/2026-01-15-fix-login-timeout.patch

2️⃣ 标准型：Git + Patch 提交规范

适合大多数开发团队

git format-patch HEAD~1

提交信息示例：

fix(auth): 修复 token 过期导致 500 错误

- 原因：JWT 校验未捕获过期异常
- 影响：登录模块
- 回滚：git revert <commit>

3️⃣ 企业型：变更管理系统

适合合规 / 金融 / 医疗

• Jira Change Request
• GitLab MR + 审批流
• 内部 Patch 管理平台

记录字段示例：

CR-2026-014
类型：Hotfix
审批人：张三
上线窗口：2026-01-20 02:00

三、Patch 文件本身怎么记

如果是 .patch / .diff 文件：

# 生成
git diff > fix-xxx.patch

# 应用
git apply fix-xxx.patch

建议在 patch 文件头部加注释：

# Patch: fix-login-timeout
# Author: lisi
# Date: 2026-01-15
# Issue: #123

四、推荐模板（直接可用）

### Patch 名称
fix-db-connection-leak

### 基本信息
- 版本：v2.3.1
- 作者：王五
- 日期：2026-01-18

### 变更说明
修复数据库连接未释放问题

### 文件变更
- dao/connection.go
- config/db.yaml

### 验证
- 单元测试通过
- 压测 1000 QPS 无泄漏

### 回滚
git revert a1b2c3d

如果你说的是某个具体系统（Linux 内核 / Kubernetes / 数据库 / 自研系统），可以告诉我，我给你更针对性的记录方式。