[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
  1. 将本地face_recognition副本安装到virtualenv中。假设你已经安装了virtualenvwrapper,这是你如何设置你的fork来进行本地开发:
$ mkvirtualenv face_recognition
$ cd face_recognition/
$ python setup.py develop
  1. 为本地开发创建一个分支:
$ git checkout -b name-of-your-bugfix-or-feature

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

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

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

  1. 提交您的更改并将您的分支推送到GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
  1. 通过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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,992评论 19 139
  • 多种多样的工作流使得在项目中实施Git时变得难以选择。这份教程提供了一个出发点,调查企业团队最常见的Git工作流。...
    JSErik阅读 4,483评论 2 8
  • 灯下读师作,更深忘倦疲。 华章通妙境,画意满诗集。 宇宙无穷尽,人生有限期。 朝朝争奋力,每每溢生机。 ...
    开宗明义阅读 194评论 0 0
  • 阎云在三楼找了一间正对着对面215的宿舍,就带着徐倩走了进去,开门用异能的时候也没有避着徐倩,而是大大放放的在徐倩...
    野性浮云阅读 574评论 4 3
  • 亲们,最近好吗 我还行吧,算是可以彻底隐了 也不算是一身轻吧,反正目前呢手头的事在一件一件的放下,终于可以做自己最...
    唯i阅读 224评论 0 0