Files
agv-control-slam/.claude/templates/release_notes_template.md
2025-11-15 14:31:47 +08:00

202 lines
4.0 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Release Notes - v{{VERSION}}
**发布日期**: {{RELEASE_DATE}}
**版本号**: {{VERSION}}
**发布类型**: {{RELEASE_TYPE}} (Major/Minor/Patch)
---
## 版本概述
{{简要描述本版本的主要更新内容和重点特性}}
## 重要变更 ⚠️
{{列出所有重大变更、破坏性更新、需要用户注意的事项}}
- **{{变更1}}**: {{详细说明}}
- **{{变更2}}**: {{详细说明}}
## 新增功能 ✨
### {{功能类别1}}
- **{{功能1名称}}**
- 说明: {{功能描述}}
- 相关文档: [{{文档名称}}]({{链接}})
- Commit: {{commit_hash}}
- **{{功能2名称}}**
- 说明: {{功能描述}}
- 相关文档: [{{文档名称}}]({{链接}})
- Commit: {{commit_hash}}
### {{功能类别2}}
- **{{功能3名称}}**
- 说明: {{功能描述}}
- 相关文档: [{{文档名称}}]({{链接}})
- Commit: {{commit_hash}}
## Bug修复 🐛
### 严重Bug修复
- **{{Bug1名称}}**
- 问题: {{问题描述}}
- 影响: {{影响范围}}
- 修复: {{修复说明}}
- Commit: {{commit_hash}}
### 一般Bug修复
- **{{Bug2名称}}** - {{简短描述}} ({{commit_hash}})
- **{{Bug3名称}}** - {{简短描述}} ({{commit_hash}})
- **{{Bug4名称}}** - {{简短描述}} ({{commit_hash}})
## 性能优化 🚀
- **{{优化项1}}**: {{优化描述和性能提升数据}}
- **{{优化项2}}**: {{优化描述和性能提升数据}}
- **{{优化项3}}**: {{优化描述和性能提升数据}}
## 文档更新 📚
- {{文档更新1}}
- {{文档更新2}}
- {{文档更新3}}
## API变更
### 新增API
```cpp
// 新增的公开接口
{{API定义}}
```
### 修改API
| API名称 | 变更类型 | 说明 | 迁移指南 |
|---------|---------|------|---------|
| {{API1}} | {{类型}} | {{说明}} | {{指南}} |
### 废弃API
| API名称 | 替代方案 | 移除计划版本 |
|---------|---------|------------|
| {{API1}} | {{替代}} | {{版本}} |
## 依赖更新
| 依赖库 | 旧版本 | 新版本 | 变更原因 |
|-------|--------|--------|---------|
| {{LIB1}} | {{OLD}} | {{NEW}} | {{原因}} |
| {{LIB2}} | {{OLD}} | {{NEW}} | {{原因}} |
## 兼容性说明
### 向后兼容性
- ✅ 完全兼容 v{{PREVIOUS_VERSION}}
- ⚠️ 部分不兼容详见API变更
- ❌ 不兼容(需要迁移)
### 系统要求
- **编译器**: {{编译器要求}}
- **操作系统**: {{OS要求}}
- **依赖库**: {{依赖要求}}
## 升级指南
### 从 v{{OLD_VERSION}} 升级
1. **备份当前版本**
```bash
{{备份命令}}
```
2. **更新代码**
```bash
{{更新命令}}
```
3. **处理API变更**
{{迁移步骤说明}}
4. **重新编译**
```bash
{{编译命令}}
```
5. **测试验证**
{{测试建议}}
### 配置迁移
{{如有配置文件格式变更,说明迁移方法}}
## 已知问题
- **{{问题1}}**: {{描述和临时解决方案}}
- **{{问题2}}**: {{描述和临时解决方案}}
## 统计数据
- **新增代码行数**: {{LINE_COUNT}}
- **修改文件数**: {{FILE_COUNT}}
- **关闭Issue数**: {{ISSUE_COUNT}}
- **Pull Request数**: {{PR_COUNT}}
- **贡献者**: {{CONTRIBUTOR_COUNT}}
## 提交历史
```
总提交数: {{COMMIT_COUNT}}
主要提交:
{{COMMIT_HASH_1}} - {{COMMIT_MESSAGE_1}}
{{COMMIT_HASH_2}} - {{COMMIT_MESSAGE_2}}
{{COMMIT_HASH_3}} - {{COMMIT_MESSAGE_3}}
...
```
## 贡献者 👥
感谢以下贡献者对本版本的贡献:
- {{CONTRIBUTOR_1}} - {{贡献说明}}
- {{CONTRIBUTOR_2}} - {{贡献说明}}
## 下一版本计划
### v{{NEXT_VERSION}} (计划中)
- [ ] {{计划功能1}}
- [ ] {{计划功能2}}
- [ ] {{计划优化项}}
## 获取此版本
### 源码下载
```bash
git clone {{REPO_URL}}
git checkout v{{VERSION}}
```
### 二进制包
- [Windows x64]({{DOWNLOAD_LINK}})
- [Linux x64]({{DOWNLOAD_LINK}})
## 反馈和支持
- **Bug报告**: {{ISSUE_URL}}
- **功能请求**: {{FEATURE_REQUEST_URL}}
- **讨论**: {{DISCUSSION_URL}}
- **文档**: {{DOCS_URL}}
---
**完整变更日志**: [v{{OLD_VERSION}}...v{{VERSION}}]({{COMPARE_URL}})
**归档位置**: `archives/versions/v{{VERSION}}/`