[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