对于贡献者¶

如果您想直接为 cliff 贡献代码，这些说明应该能帮助您入门。可以通过 Storyboard 项目提交错误报告和功能请求。

对 cliff 的修改应通过 Gerrit 工具提交以供审查，并遵循 https://docs.openstack.org/infra/manual/developers.html#development-workflow 中记录的工作流程。

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

错误应在 Storyboard 项目下提交。

注意

在向 clif 核心贡献新功能之前，请考虑是否应该将其作为扩展来实现。该架构高度可插拔，正是为了保持核心的小巧。

运行测试¶

cliff 的测试套件使用 tox，必须单独安装 (pip install tox)。

要运行标准的测试集，请从 git 仓库的顶层目录运行 tox。

要运行单个环境，请使用 -e 参数指定它。例如

$ tox -e pep8

通过修改现有文件或在 tests 目录中创建新脚本来添加新的测试。

cliff 的文档使用 reStructuredText 编写，并使用 Sphinx 转换为 HTML。与测试一样，可以使用 tox 构建文档。

$ tox -e docs

文档的输出版本最终位于 ./docs/build/html。