发布说明
每当您打开拉取请求时,其内容将基于此拉取请求模板自动填充。
md
...
发布说明:
- N/A _或_ 添加/修复/改进了 ...在每周三,我们会运行 get-preview-channel-changes,该脚本会收集已合并到预览通道的拉取请求中的 发布说明 行,具体说明请参见发布文档。
该脚本会输出 发布说明 行之后的所有内容,包括元数据,例如拉取请求作者(如果不是 Zed 团队成员)和拉取请求的链接。 如果您使用 N/A,脚本将完全跳过您的拉取请求。
编写 发布说明 行的指南
- 只有当用户能够看到或感受到 Zed 中的变化时,才应编写
发布说明行。 发布说明行的编写应让 Zed 用户能够理解该变更是什么。 不要假设用户了解技术编辑器开发者的行话;要用用户作为文本编辑器使用者能够理解的语言来描述您的变更。- 如果您想为其他团队成员查看的拉取请求包含技术细节,请在
发布说明行之上进行说明。 - 对文档的更改应标记为
N/A。 - 如果您的拉取请求添加/更改了设置或键绑定,请务必提及该设置或键绑定。 不要让用户去查阅文档或拉取请求来查找这些信息(尽管文档中也应包含这些信息)。
- 对于回滚的拉取请求:
- 如果被回滚的项已经发布,请包含一条
发布说明来解释我们回滚的原因,因为这是一个破坏性变更。
- 如果被回滚的项已经发布,请包含一条
- 如果被回滚的项尚未发布,请将原始拉取请求的
发布说明行编辑为N/A;否则,它仍会被包含,并且发布说明编译器可能不知道要跳过它。