[face_recognition中文文档] 第5节 特约贡献

Contributing特约贡献

欢迎贡献,非常感谢!每一点帮助,都是肯定。
你可以在许多方面做出贡献:

贡献类型

报告错误

https://github.com/ageitgey/face_recognition/issues上报告错误。

如果您报告错误,请包括如下信息:

  • 您的操作系统名称和版本。
  • 有关本地设置的任何细节可能有助于排除故障。
  • 详细的步骤重现错误。

提交反馈

发送反馈的最佳方法是在https://github.com/ageitgey/face_recognition/issues上提出问题。

如果您提出了一个功能,请包括如下信息:

  • 详细解释它将如何工作。
  • 尽可能的缩小范围,使其更容易实现。
  • 请记住,这是一个志愿者驱动的项目,欢迎您的贡献:)

开始吧!

准备贡献?以下是如何设置face_recognition进行本地开发。

  1. 首先Fork face_recognition 源码到你自己的Github仓库
  2. 再克隆你上一步Fork到自己的Github上的face_recognition到本地:

    1
    $ git clone git@github.com:your_name_here/face_recognition.git
  3. 将本地face_recognition副本安装到virtualenv中。假设你已经安装了virtualenvwrapper,这是你如何设置你的fork来进行本地开发:

    1
    2
    3
    $ mkvirtualenv face_recognition
    $ cd face_recognition/
    $ python setup.py develop
  4. 为本地开发创建一个分支:

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

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

  1. 完成更改后,请检查您的更改是否通过了flake8测试,包括使用tox测试其他Python版本:
    1
    2
    3
    $ flake8 face_recognition tests
    $ python setup.py test or py.test
    $ tox

要获取flake8和tox,只需将它们安装到您的virtualenv中即可。

  1. 提交您的更改并将您的分支推送到GitHub:

    1
    2
    3
    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
  2. 通过GitHub网站提交Pull Request。

Pull Request指南

在提交Pull Request之前,请检查它是否符合以下准则:

  1. Pull Request应包括tests。
  2. 如果Pull Request添加功能,则应更新文档。将新功能放入带有docstring的函数中,并将该功能添加到README.rst中的列表中。
  3. 引用请求应该适用于Python 2.6,2.7,3.3,3.4和3.5以及PyPy。检查https://travis-ci.org/ageitgey/face_recognition/pull_requests ,并确保所有受支持的Python版本通过测试。

提示

运行子测试:

1
$ python -m unittest tests.test_face_recognition

 

 

本文地址:http://www.kangvcar.com/face-recognition中文文档-第5节-特约贡献/
转载请注明出处,谢谢!

坚持原创技术分享,随意打赏!您的支持将鼓励我继续创作!
-------------感谢您的阅读-------------