贡献代码¶
创建PR¶
我们欢迎任何人贡献代码到VeighNa。
如果希望贡献代码请使用Github的PR(Pull Request)的流程。
PR流程大致如下:
创建 Issue - 对于较大的改动(如新功能,大型重构等)建议先开issue讨论一下, 较小的improvement(如文档改进,bugfix等)直接发PR即可
Fork [VeighNa][#GithubVnpy] - 点击右上角Fork按钮
Clone你自己的fork:
git clone https://github.com/$userid/vnpy.git
如果你的fork已经过时,需要手动sync
从dev创建你自己的branch:
git checkout -b $my_feature_branch dev
在$my_feature_branch上修改并将修改push到你Fork之后的仓库上
创建从你的fork的$my_feature_branch分支到主项目的dev分支的[Pull Request]:点开这里 ,再点击compare across forks,选择需要的fork和branch创建PR
创建完PR之后请耐心等待:我们一旦有空就会检查PR,一旦你的代码有用且符合要求,就会被合并!
代码风格¶
在为VeighNa写代码的时候,需要遵循一些基本的规则,否则你的代码可能无法被merge。 这些规则包括:
命名规则¶
我们的代码的命名规则如下:
类属性、类方法、参数和变量使用小写加下划线的形式
类名使用驼峰式命名
常量使用大写加下划线的形式
例如:
DEFAULT_PATH = "/tmp/VeighNa/"
class ClassA:
def __init__(self, arg_one: int, arg_two: str):
if arg_two is None:
arg_two = DEFAULT_PATH
self.property_one = arg_one
variable_one = "some string"