面向使用 Assists 的开发者与普通用户。每条更新应让人一眼看出:多了什么、修了什么、哪里更好用了。
- 用日常中文,避免类名、接口名、代码符号(如
assistsxLog、Room、globalDbCallIntercepts);过期迁移条目除外(见第 7 条) - 每条以 新增、修复、优化、调整 开头
- 写结果,不写实现:
- ✅ 新增:日志文件支持自定义保存位置和文件名
- ❌ 新增:
LogTarget与globalLogCallIntercepts拦截链
- 一条只说一件事
- 版本号:仅已正式发布(含 Maven Central / Git 标签)的版本写具体号;未发布内容放在 待发布,不写尚未发布的版本号
- 已发布版本标题格式:
### x.y.z(YYYY-MM-DD) - 过期(Deprecated):必须写出过期的方法/接口名,以及建议改用的方法/接口名,便于对照迁移:
- ✅ 调整:
loadWebViewOverlay/closeOverlay已标记过期,请改用assistsxFloat的open/close - ❌ 调整:旧的网页浮窗打开/关闭方式已标记过期,建议改用新的浮窗方式
- ✅ 调整:
| 分类 | 含义 |
|---|---|
| 新增 | 以前没有、现在能用的能力 |
| 修复 | 以前有问题、现在修好了 |
| 优化 | 体验、性能、稳定性变好 |
| 调整 | 功能取舍、配置或流程变化 |
- 发版前:
git log梳理自上一已发布版本以来的提交 - 按规则改写成条目,写入 待发布
- 正式发布并打 tag 后:将 待发布 移到对应版本号下,并清空 待发布