🚀 快速安装
复制以下命令并运行，立即安装此 Skill：
npx @anthropic-ai/skills install supercent-io/skills-template/changelog-maintenance💡 提示：需要 Node.js 和 NPM
更新日志维护
何时使用此技能
- 发布前：在发布版本前整理更改
- 持续更新：每当发生重大更改时更新
- 迁移指南：记录破坏性变更
指示
步骤 1：遵循更新日志格式
CHANGELOG.md：
# 更新日志
此项目的所有显著更改都将记录在此文件中。
格式基于[Keep a Changelog](https：//keepachangelog.com/zh-CN/1.0.0/)，
并且本项目遵循[语义化版本](https：//semver.org/lang/zh-CN/)。
## [未发布]
### 新增
- 新的用户资料自定义选项
- 深色模式支持
### 变更
- 改进了搜索功能的性能
### 修复
- 密码重置邮件中的错误
## [1.2.0] - 2025-01-15
### 新增
- 双因素认证
- 导出用户数据功能（符合 GDPR 要求）
- API 速率限制
- 订单事件的 Webhook 支持
### 变更
- 更新了仪表板的 UI 设计
- 改进了邮件模板
- 数据库查询优化（速度提升 40%）
### 弃用
- `GET /api/v1/users/list`（请改用 `GET /api/v2/users`）
### 移除
- 旧的认证方式（基本认证）
### 修复
- 后台任务处理器中的内存泄漏
- Safari 浏览器中的 CORS 问题
- 日期选择器中的时区错误
### 安全
- 更新了依赖项（修复了 CVE-2024-12345）
- 实现了 CSRF 保护
- 添加了 helmet.js 安全头
## [1.1.2] - 2025-01-08
### 修复
- 支付处理中的严重错误
- 会话超时问题
## [1.1.0] - 2024-12-20
### 新增
- 用户头像
- 邮件通知
- 搜索功能
### 变更
- 重新设计了登录页面
- 改进了移动端响应式
## [1.0.0] - 2024-12-01
初始版本
### 新增
- 用户注册和认证
- 基本资料管理
- 产品目录
- 购物车
- 订单管理
[未发布]: https：//github.com/username/repo/compare/v1.2.0...HEAD
[1.2.0]: https：//github.com/username/repo/compare/v1.1.2...v1.2.0
[1.1.2]: https：//github.com/username/repo/compare/v1.1.0...v1.1.2
[1.1.0]: https：//github.com/username/repo/compare/v1.0.0...v1.1.0
[1.0.0]: https：//github.com/username/repo/releases/tag/v1.0.0
步骤 2：语义化版本控制
版本号：主版本号.次版本号.修订号
给定一个版本号 主版本号.次版本号.修订号，递增规则如下：
主版本号 (1.0.0 → 2.0.0)：破坏性变更
- API 更改会破坏现有代码
- 示例：添加必需参数、更改响应结构
次版本号 (1.1.0 → 1.2.0)：向后兼容的新功能
- 添加新功能
- 现有功能继续工作
- 示例：新的 API 端点、可选参数
修订号 (1.1.1 → 1.1.2)：向后兼容的错误修复
- 错误修复
- 安全补丁
- 示例：修复内存泄漏、修复拼写错误
示例：
1.0.0→1.0.1：错误修复1.0.1→1.1.0：新功能1.1.0→2.0.0：破坏性变更
步骤 3：发布说明（面向用户）
# 发布说明 v1.2.0
**发布日期**：2025年1月15日
## 🎉 新特性
### 双因素认证
您现在可以启用双因素认证以增强安全性。前往设置 > 安全进行设置。
### 导出您的数据
我们新增了以 JSON 格式导出所有数据的功能。非常适合备份或迁移您的账户。
## ✨ 改进
- **更快的搜索**：得益于数据库优化，搜索速度现在提升了 40%
- **更好的邮件**：重新设计了邮件模板，外观更简洁
- **仪表板焕新**：使用现代设计更新了 UI
## 🐛 错误修复
- 修复了密码重置邮件未发送的错误
- 解决了日期选择器中的时区问题
- 修复了后台作业中的内存泄漏
## ⚠️ 破坏性变更
如果您正在使用我们的 API：
- **已移除**：不再支持基本认证
- **迁移**：请改用 JWT 令牌（请参阅[认证指南](docs/auth.md)）
- **已弃用**：`GET /api/v1/users/list`
- **迁移**：请使用带分页的 `GET /api/v2/users`
## 🔒 安全
- 将所有依赖项更新至最新版本
- 在所有表单中添加了 CSRF 保护
- 使用 helmet.js 实现了安全头
## 📝 完整更新日志
详情请参阅 [CHANGELOG.md](CHANGELOG.md)。
---
**升级说明**：[docs/upgrade-to-v1.2.md](docs/upgrade-to-v1.2.md)
步骤 4：破坏性变更迁移指南
# 迁移指南：v1.x 到 v2.0
## 破坏性变更
### 1. 认证方式已更改
**之前** (v1.x)：
\`\`\`javascript
fetch('/api/users'， {
headers： {
'Authorization'： 'Basic ' + btoa(username + '：' + password)
}
})；
\`\`\`
**之后** (v2.0)：
\`\`\`javascript
// 1. 获取 JWT 令牌
const { accessToken } = await fetch('/api/auth/login'， {
method： 'POST'，
body： JSON.stringify({ email， password })
}).then(r => r.json())；
// 2. 使用令牌
fetch('/api/users'， {
headers： {
'Authorization'： 'Bearer ' + accessToken
}
})；
\`\`\`
### 2. 用户列表 API 响应格式
**之前** (v1.x)：
\`\`\`json
{
"users"： [...]
}
\`\`\`
**之后** (v2.0)：
\`\`\`json
{
"data"： [...],
"pagination"： {
"page"： 1，
"limit"： 20，
"total"： 100
}
}
\`\`\`
**迁移**：
\`\`\`javascript
// v1.x
const users = response.users；
// v2.0
const users = response.data；
\`\`\`
## 弃用时间线
- v2.0 (2025年1月)：基本认证被标记为弃用
- v2.1 (2025年2月)：使用基本认证时记录警告日志
- v2.2 (2025年3月)：移除基本认证
输出格式
CHANGELOG.md # 面向开发者的详细日志
RELEASES.md # 面向用户的发布说明
docs/migration/
├── v1-to-v2.md # 迁移指南
└── v2-to-v3.md
约束条件
必需规则（必须遵守）
- 时间倒序：最新版本在最上面
- 包含日期：ISO 8601 格式 (YYYY-MM-DD)
- 分类记录：新增、变更、修复等
禁止事项（不得违反）
- 不复制 Git 日志：从用户的角度撰写
- 措辞模糊：“错误修复”、“性能改进”（要具体）
最佳实践
- 保持更新日志：遵循标准格式
- 语义化版本：一致的版本管理
- 破坏性变更：提供迁移指南
参考资料
元数据
版本
- 当前版本：1.0.0
- 最后更新：2025-01-01
- 兼容平台：Claude, ChatGPT, Gemini
标签
#更新日志 #发布说明 #版本控制 #语义化版本 #文档
示例
示例 1：基本用法
示例 2：高级用法
📄 原始文档
完整文档（英文）：
https://skills.sh/supercent-io/skills-template/changelog-maintenance
💡 提示：点击上方链接查看 skills.sh 原始英文文档，方便对照翻译。
声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。
评论(0)