---
# System prepended metadata

title: Changelog 调查记录

---

# Changelog 调查记录
### [腾讯云 changelog](https://raw.githubusercontent.com/Tencentchangelogoud/tencentchangelogoud-sdk-java/master/CHANGELOG.md)

对单次 release 会有一个简短的描述

1.  描述接口增加，修改
2.  描述数据结构的增加修改

上面内容都会附带 api 文档链接，这个我觉得我们应该也要有，没有业务内容的描述，另外没有 bugfix 的内容，感觉很不可思议。

### [阿里云 changelog](https://github.com/aliyun/aliyun-openapi-java-sdk/blob/master/aliyun-java-sdk-core/ChangeLog.txt)

被标记为了 release note，文件名是 changelog，记录了业务上的修改，例如新增功能，bug 修复但是没有附带数据结构，api 的改变，记录内容比较简短，一句话。

### [aws changelog](https://github.com/aws/aws-sdk-js/blob/master/CHANGELOG.md)

与阿里一样，简短记录业务上的改变，看上去是通过 git commit 生成的，比 ali 做得好的是会标记是哪个业务模块做了改变。

### [七牛 changelog](https://github.com/qiniu/java-sdk/blob/master/CHANGELOG.md)

于阿里类似，简单记录业务变更，但是会标记新增，删除，修复，对于新增的偶尔会添加一个链接指向 api 文档。

基本上调查的 sdk 都对 release note 和 changelog 分的不是很清，基本都把两个当一个用。

我目前的看法是我们可以维护一个 release note 作为 changelog 来用，规范的话我倾向于 tengxun 云的版本，但是对于业务功能也应该有一个简短的描述
[草案模板](https://hackmd.io/w2Hp876cQOmhQj4699yD5g)



### 其他

另外为保证changelog不会遗漏信息，对operation-api，sdk做的任何修改都应有jira ticket打上标签并记录。