发布说明

每当您发起拉取请求时，其正文将根据此拉取请求模板自动填充。

...

Release Notes:

- N/A _or_ Added/Fixed/Improved ...

每周三，我们会运行一个 get-preview-channel-changes 脚本，该脚本会从进入预览状态的拉取请求中抓取 Release Notes 行，具体请参阅我们的发布文档。

该脚本会输出 Release Notes 行下面的所有内容，包括附加数据，例如拉取请求作者（如果不是 Zed 团队成员）以及指向拉取请求的链接。如果您使用 N/A，脚本将完全跳过您的拉取请求。

编写 Release Notes 行的指南

• 只有当用户能在 Zed 中看到或感受到差异时，才应编写 Release Notes 行。
• Release Notes 行的编写应确保 Zed 用户能够理解更改是什么。不要假设用户了解技术编辑器开发人员的行话；用他们作为文本编辑器用户能理解的语言来描述您的更改。
• 如果您想为其他团队成员提供有关拉取请求的技术详细信息，请将其放在 Release Notes 行之上。
• 对文档的更改应标记为 N/A。
• 如果您的拉取请求添加/更改了设置或键绑定，请务必提及该设置或键绑定。不要让用户深入文档或拉取请求中查找此信息（尽管它也应包含在文档中）。
• 对于回滚的拉取请求
  • 如果被回滚的项目已发布，请包含一条 Release Notes 行，解释我们回滚的原因，因为这是一个重大更改。
  • 如果被回滚的项目尚未发布，请将原始 PR 的 Release Notes 行编辑为 N/A；否则，它将被包含在内，发布说明的编译者可能不知道要跳过它，从而导致我们声称发布了实际上没有发布的东西，这可能会造成尴尬。