贡献代码

    PR流程大致如下：

    • Fork [vn.py][#GithubVnpy] - 点击右上角Fork按钮

    • Clone你自己的fork:

    • 从dev创建你自己的branch:

    • 在$my_feature_branch上修改并将修改push到你Fork之后的仓库上

    • 创建从你的fork的$my_feature_branch分支到主项目的dev分支的[Pull Request]:点开这里 ，再点击compare across forks，选择需要的fork和branch创建PR

    创建完PR之后请耐心等待：我们一旦有空就会检查PR，一旦你的代码有用且，就会被合并！

    代码风格

    我们的代码的命名规则如下：

    • 类属性、类方法、参数和变量使用小写加下划线的形式
    • 类名使用驼峰式命名
    • 常量使用大写加下划线的形式 例如：

    我们对代码格式没有特别严格的要求，但是至少要符合pep8标准，并且额外要在类和所有函数下面带上docstring(就是一段””””””)。

    要让代码符合pep8标准，写完代码之后使用格式化你的代码就可以了:

      使用flake8检查你的代码，确保没有error和warning。在项目根目录下运行就可以检查出代码中书写不严谨的地方了。如果检查出error或者warning，说明你的代码需要进行一些修改以提升质量。