贡献

欢迎贡献,我们非常感谢!每一份努力都有帮助,并且会始终给予相应的认可。

错误报告

报告错误时,请包含以下信息:

  • 您的操作系统名称和版本。

  • 任何可能有助于排查问题的本地设置详细信息。

  • 重现错误的详细步骤。

文档改进

pytest-cov 始终需要更多文档,无论是作为官方 pytest-cov 文档的一部分,还是在文档字符串中,甚至是在网络上的博客文章、文章等中。

功能请求和反馈

发送反馈的最佳方式是在 https://github.com/pytest-dev/pytest-cov/issues 上提交问题。

如果您正在提议一个功能

  • 详细解释它的工作原理。

  • 尽可能缩小范围,以便于实现。

  • 请记住,这是一个由志愿者驱动的项目,并且欢迎代码贡献 :)

开发

要为本地开发设置 pytest-cov

  1. Fork pytest-cov(查找“Fork”按钮)。

  2. 在本地克隆您的 fork

    git clone git@github.com:YOURGITHUBNAME/pytest-cov.git
    
  3. 创建本地开发分支

    git checkout -b name-of-your-bugfix-or-feature
    

    现在您可以在本地进行更改。

  4. 完成更改后,使用一个命令运行所有检查和文档构建器

    tox
    
  5. 提交您的更改并将您的分支推送到 GitHub

    git add .
    git commit -m "Your detailed description of your changes."
    git push origin name-of-your-bugfix-or-feature
    
  6. 通过 GitHub 网站提交拉取请求。

拉取请求指南

如果您在开发代码时需要一些代码审查或反馈,只需创建拉取请求即可。

合并时,您应该

  1. 包含通过的测试(运行 tox)。

  2. 在有新的 API、功能等时更新文档。

  3. CHANGELOG.rst 中添加关于更改的说明。

  4. 将自己添加到 AUTHORS.rst 中。

提示

要运行测试子集

tox -e envname -- pytest -k test_myfeature

并行运行所有测试环境

tox -p auto