[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到本地：

$ git clone git@github.com:your_name_here/face_recognition.git

3. 将本地face_recognition副本安装到virtualenv中。假设你已经安装了virtualenvwrapper，这是你如何设置你的fork来进行本地开发：

$ mkvirtualenv face_recognition
$ cd face_recognition/
$ python setup.py develop

4. 为本地开发建立一个分支：

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

如今您能够在本地进行更改。

5. 完成更改后，请检查您的更改是否经过了flake8测试，包括使用tox测试其余Python版本：

$ flake8 face_recognition tests
$ python setup.py test or py.test
$ tox

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

6. 提交您的更改并将您的分支推送到GitHub：

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

7. 经过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版本经过测试。

提示

运行子测试：

$ python -m unittest tests.test_face_recognition