OpenStack Heat 规范

这个 git 仓库用于存放 Heat 项目的已批准的设计规范。规范的评审在 gerrit 中进行，流程与我们评审和合并代码变更的方式类似。

这个仓库的布局是

specs/<release>/

规范针对特定发布版本提出时，将其添加到 specs/<release> 目录并发布以供评审。可以通过查看 launchpad 中的蓝图来了解给定发布版本的蓝图实现状态。并非所有已批准的蓝图都会完全实现。

您可以在 specs/template.rst 中找到一个示例规范。

有一个子目录 specs/<release>/backlog 用于存储所有已批准但未在特定版本中实现的规范。

规范的移动到 backlog 将在发布周期结束时批量完成。

在 Juno 开发周期之前，此仓库未用于规范评审。Juno 之前的评审完全通过 Launchpad 蓝图完成。

http://blueprints.launchpad.net/heat

请注意，Launchpad 蓝图仍然用于跟踪蓝图的当前状态。有关更多信息，请参阅

https://wiki.openstack.org/wiki/Blueprints

有关使用 gerrit 的更多信息，请参阅

http://docs.openstack.org/infra/manual/developers.html#development-workflow

为了验证规范在语法上是否正确（即，获得更多 Jenkins 结果的信心），请执行以下命令

$ tox

运行 tox 后，文档将以 HTML 格式在 doc/build/ 目录中提供。请不要将生成的 HTML 文件作为您提交的一部分签入。