数据源可能暂停更新:最后一次成功检查是 UTC,距今已超过 3 小时。页面上的时间仍按官方原帖计算,但最近几小时的新公告可能还没收录——以官方账号为准。
写 CHANGELOG 和发版说明
分类:文档 · 更新于 2026-09-21 · 适用工具:两者
适合准备发新版本、但提交记录比较随意、需要整理成用户能看懂的说明的场景。消耗量级:小到中,取决于两个版本之间的提交数量。
提示词全文
请基于 <起始版本/标签> 到 <结束版本/标签或 HEAD> 之间的实际提交记录和改动内容生成发版说明,不要凭空编造没有对应提交的功能点。分成“新功能”“修复”“其他改动(如重构、依赖升级)”三类,每一类下面用一句话描述用户能感知到的变化,避免直接照抄提交信息里的技术术语。如果某类提交涉及可能影响现有用户的行为变化(比如接口参数变了),单独在“需要注意”里列出来。最后给出一份可以直接贴到 CHANGELOG.md 里的 Markdown 片段。
使用建议
- 强调“不要编造没有对应提交的功能”,防止它为了内容丰富而添油加醋
- 行为变化类的改动一定要单独列出来提醒,用户最怕的就是不知不觉被改了行为
- 面向用户的描述和面向开发者的技术细节分开写,别混在一起