8bb0bb5fbf
[Add] 增加对binding和tests的代码质量检查 [Add] 更新README.md
23 lines
878 B
Markdown
23 lines
878 B
Markdown
vnpy 2.0
|
||
|
||
## 贡献代码
|
||
---
|
||
|
||
如果你遇到了任何BUG,欢迎[创建 Issue]。
|
||
|
||
我们热烈欢迎任何人为我们的项目贡献代码。无论是多么细小的改工,都可以[提交PR],我们会认真对待每一个PR。
|
||
|
||
在提交代码的时候,请遵守以下规则,以提高代码质量:
|
||
|
||
* 使用[black]格式化你的代码。运行```black .```即可。
|
||
* 使用[pylint]检查你的代码(主要检查命名规则),确保没有error和warning。在项目根目录下运行```pylint vnpy```即可。
|
||
* 使用[flake8]检查你的代码,确保没有error和warning。在项目根目录下运行```flake8```即可。
|
||
|
||
[yapf]:https://github.com/google/yapf
|
||
[pylint]:https://github.com/PyCQA/pylint
|
||
[提交PR]:https://help.github.com/articles/creating-a-pull-request/
|
||
[创建 Issue]:http://pylint.pycqa.org/en/latest/tutorial.html
|
||
|
||
|
||
|