Neutron 发行说明编写指南

发行说明是 OpenStack 项目中记录新特性的新功能。关于流程、工具和方法的背景信息记录在 Doug Hellmann 的邮件列表帖子 中。

编写发行说明

有关如何创建发行说明的信息，请参阅 reno 文档。

在编写发行说明时，请牢记以下几点。

• 避免在单个发行说明中使用“序言”部分。“序言”部分用于关于发行版的通用评论。

• 每个部分使用一个条目（例如“特性”或“升级”）。所有属于同一发行版的条目将被合并并渲染，因此单个主题使用多个条目意义不大。

维护发行说明

警告

即使与您的更改相关，也请避免修改现有的发行说明文件。如果您修改了过去发行版的发行说明文件，则整个内容将在最新发行版中显示。允许的唯一情况是在同一发行版中更新发行说明。

如果您需要更新过去发行版的发行说明，请直接编辑稳定分支中的相应发行说明文件。