简体中文 | English
鼓励并感谢为PaddleViT项目提供贡献的研究人员和开发人员。
您需要同意PaddleViT 参与者许可协议,方可以参与PaddlePaddle贡献。
本文档描述了我们的工作流程和代码风格。
PaddleViT 使用这个Git 分支模型. 您可以按照以下步骤提交代码并参与贡献.
请从您的fork中提交 Pull Requests
.
只需要前往我们的 GitHub repo 页面并点击 "Fork" 按钮.
将您的fork复制到本地:
$ git clone https://github.com/your-github-account/PPViT
$ cd PPViT
对于日常工作例如添加新功能或修复错误,请在编码之前基于develop
分支创建一个 feature
分支:
$ git checkout develop
$ git checkout -b feature
其中feature
可以替换为你正在处理的功能的名称.
during and after
您的更改,将代码提交到本地存储库.
$ git add -A
$ git commit -m “message”
- 我们鼓励编写
unittest
来测试你编写的类与方法的实现. - 在开始合并之前,请在相关数据集上测试模型的性能。
在准备发起Pull Request之前,需要同步原仓库中最新的代码。
有经验的Git用户会经常从官方存储库中pull数据--每天甚至每小时,因此他们会尽早注意到与其他人的工作冲突,并且更容易解决较小的冲突。
$ git remote add upstream https://github.com/BR-IDL/PaddleViT
$ git pull upstream develop
-
Push 您的本地工作到您的fork仓库中:
$ git push origin my-cool-stuff
其中,
my-cool-stuff
是您的分支名称push操作允许您创建一个pull request,请求此 official repo 将您的更改拉入到官方库中.
-
想要创建一个
Pull Request
, 请按照 这些步骤.如果您的更改是
fixing an issue
, 请在pull request的描述部分写下"Fixes ". 当合并您的 pull request时,Github将关闭该问题.请记住为您的pull request指定审阅者. 如果您不知道正确的选择,请遵循Github的推荐.
成功合并到develop
分支后,删除您的feature
分支。
为了保持您的本地工作区和fork简洁,您可能想要删除合并的分支:
$ git push origin :my-cool-stuff
$ git checkout develop
$ git pull upstream develop
$ git branch -d my-cool-stuff
-
请随时通过 IM 或电子邮件来 ping 您的审阅者以发送您的pull request.
-
请回答审阅者的每一条评论. 如果您要关注评论,请写“完成”;否则请给出理由。
-
如果您不希望您的审阅者被电子邮件通知淹没,可以通过 批量 回复评论.
-
减少非必要的提交. 存在一些开发人员经常提交,建议通过运行
git commit --amend
代替git commit
,将一系列小的变动附加到一个提交中.
我们的Python代码遵循 PEP8 language guide 以及 PEP8 style guide.
Pylint 是一款 Python代码分析工具,可以分析Python代码中的错误,发现不符合编程标准或存在潜在问题的代码。
为了让其他人更容易使用并生成在线文件,请在每个类方法的每个函数中包含文档的描述字符串。
请记得添加相关的单元测试
- 对于 Python 代码, 请使用 Python's standard
unittest
package.
尝试对每个类方法的每个函数都进行单元测试。