贡献 OpenStack 文档工具

如果您希望为 OpenStack 文档工具做出贡献，欢迎提交补丁或针对该工具包提交错误报告。

贡献工具开发

要为 openstack-doc-tools 的开发做出贡献，请按照以下步骤操作：

  1. 完成 开发者指南 中描述的步骤。

  2. 在开发工具改进时，请遵循 OpenStack 风格规范。

  3. 在提交您的更改请求之前，请运行测试。

    目前，文档工具包使用基本的 flake8 和 bashate 测试进行测试。欢迎提供测试套件。

  4. 通过 Gerrit 工具提交您的更改以供审查，如 gerrit 工作流程 中所述。

    警告

    通过 GitHub 提交的拉取请求将被忽略。

注意

为了能够成功地在本地运行 "tox -e py27"，请将 jinja2 和 markupsafe 添加到您的本地 test-requirements.txt 文件中，以便在您的本地虚拟环境中安装它们。

针对工具提交错误报告

如果您在使用工具时遇到问题，请在 Launchpad 的 openstack-doc-tools 项目 中提交错误报告。请勿在 GitHub 上提交问题。