第151章 编写发布说明（Release Notes）指南

每当你创建 pull request 时，正文会自动根据这个 pull request 模板 生成。

...

Release Notes:

- N/A _或_ Added/Fixed/Improved ...

每周三我们会运行 get-preview-channel-changes 脚本，按 Release 文档的说明，从进入 preview 频道的 pull request 中收集 Release Notes 行。

该脚本会输出 Release Notes 行之后的所有内容，包括元信息，比如 pull request 作者（如果不是 Zed 团队成员）以及指向该 pull request 的链接。 如果填的是 N/A，脚本会完全跳过你的 pull request。

编写 Release Notes 行的准则

• 只有当用户能在 Zed 中看到或感受到差异时，才需要写 Release Notes 行。
• Release Notes 行要让 Zed 用户能看懂这次改动是什么。不要假设用户懂编辑器开发者的技术术语，要用文本编辑器用户能理解的语言来描述。
• 如果你想为团队其他成员补充 pull request 的技术细节，请写在 Release Notes 行上方。
• 文档相关的改动应标记为 N/A。
• 如果你的 pull request 新增或修改了设置项或快捷键，务必写明。不要让用户去翻文档或 pull request 找这些信息（当然这些内容也应写入文档）。
• 对于回滚（revert）类的 pull request：
• 如果被回滚的内容已经发布，要写一条 Release Notes 行说明回滚原因，因为这是破坏性变更。
• 如果被回滚的内容尚未发布，把原 PR 的 Release Notes 行改为 N/A；否则它仍会被收录，而且整理发布说明的人可能不知道要跳过它。