同步操作将从 PaddlePaddle/PaddleHub 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
PaddleHub非常欢迎贡献者。
首先,如果有什么不确定的事情,可随时提交问题或拉取请求。 不会有人因此而抱怨。我们会感激任何形式的贡献,不想用一堆规则来阻止这些贡献。
本文档包括了所有在贡献中需要注意的要点,会加快合并代码、解决问题的速度。
查看概览来初步了解。
下面是一些简单的贡献指南。
当你使用PaddleHub遇到问题时,可以通过提交issue来反馈。
在提出问题时,请说明以下事项:
在适配使用场景时,总会需要一些新的功能。 可以加入新功能的讨论,也可以直接提交新功能的Pull-Request请求。
在自己的 github 账户下 fork PaddleHub(https://github.com/PaddlePaddle/PaddleHub)。 在 fork 后, 利用git工具(add, commit, pull, push)提交PR。 然后就可以提交拉取请求了。
如何提PR,参考下列步骤:
https://github.com/USERNAME/PaddleHub
git checkout develop
git checkout -b new-feature
PaddleHub开发人员使用pre-commit工具来管理Git预提交钩子。它可以帮助我们格式化源代码Python,在提交(commit)前自动检查一些基本事宜(如每个文件只有一个 EOL,Git 中不要添加大文件等)。
pre-commit测试是 Travis-CI 中单元测试的一部分,不满足钩子的PR不能被提交到Paddle,首先安装并在当前目录运行它:
➜ pip install pre-commit
➜ pre-commit install
git commit -m "add new feature"
通过 git remote 查看当前远程仓库的名字。
➜ git remote
origin
➜ git remote -v
origin https://github.com/USERNAME/PaddleHub (fetch)
origin https://github.com/USERNAME/PaddleHub (push)
这里 origin 是自己用户名下的PaddleHub,接下来创建一个原始PaddleHub仓库的远程主机,命名为 upstream。
➜ git remote add upstream https://github.com/PaddlePaddle/PaddleHub
➜ git remote
origin
upstream
获取 upstream 的最新代码并更新当前分支。
➜ git fetch upstream
➜ git pull upstream develop
➜ git push origin new-feature
这样你的PaddleHub库的new-feature分支包含了你的最新更改,点击上面的“pull request”就可以推送请求了。
如果评审人员给出了反馈需要继续修正代码,可以从第五步重新开始,这样所有的提交都会显示到同一个pull request中。
flake8
或pylint
的提示工具来帮助遵循规范。文档使用了 sphinx 来生成,支持 Markdown 和 reStructuredText 格式。 所有文档都在 docs/ 目录下。
在提交文档改动前,请先在本地生成文档:cd docs/ && make clean && make html
,然后,可以在 docs/_build/html
目录下找到所有生成的网页。 请认真分析生成日志中的每个 WARNING,这非常有可能是或空连接或其它问题。
需要链接时,尽量使用相对路径。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。