PLUTUS RESEARCH & TRADING FRAMEWORK
本组织包含构成Plutus投研框架的各个功能模块以及项目结构,使用者仅需将Plutus项目git clone至本地后,再将自己所需的功能模块git clone至该项目中,简单配置后即可投入使用。
如何开始?
如果你是使用者
- 首先将plutus项目克隆至本地
- cd plutus, 进入plutus项目根目录下后,在根目录下运行git clone xxx,将你所需要的模块克隆至plutus项目中
- 配置requirements, config.ini等文件
- 大功告成,你可以开始使用本框架了。
如果你是开发者
前面的步骤与使用者无异,但当你准备将你的代码提交至远程仓库时,请参考以下 ”具体步骤“ 及注意事项。
具体步骤
如何创建自己的项目分支,并在修改代码后提交pull request:
https://blog.csdn.net/weixin_43643121/article/details/108645655
常用git命令:
- 初始化本地git repo: git init
- 向本地git repo添加远程代码仓库: git remote add origin https://gitee.com/xxx/xxx.git
1-2步骤也可以用git clone 代替: git clone https://gitee.com/xxx/xxx.git 这样即把远程代码仓库克隆到本地。
- 在本地git repo中添加你所属的开发分支,例如名为dev的开发分支:git branch dev
- 本地切换到开发分支:git checkout dev
- 提交修改:
5.1 git add * (添加所有修改) / 或IDE中选择需要提交的修改(pycharm面板右上角的✔符号)
5.2 git commit -m "your note" 提交此次修改 (IDE中选择完需要提交的文件,填写commit note后点击commit)
5.3 git push [--set-upstream origin {dev}] 向远程仓库中提交此次修改,如果你第一次向远程仓库中提交代码,最好加上方括号中的内容;花括号部分是你所属的开发分支。由于master分支受保护,你无法向master分支直接提交修改,所以必须本地git checkout {dev} 切换到你所属的开发分支后再进行代码提交(注意:为方便管理,本地的dev分支名称应与远端dev分支名称相同) (IDE中点击push进行推送。)
- 提交pull request: 如果你的代码需要被合并到master分支,则请在对应的module项目中提交pull request,新建pull request后,代码将被审核员进行审核,通过后合并至master分支。
***** 注意事项 *****
在向各个模块的代码仓库提交代码时,请务必从对应的模块目录中进行操作,以免将整个Plutus项目push到单一模块代码仓库中。
***** 异常处理 *****
- pull request显示无法自动合并:
- 一般情况下是由于两个分支之间差异过大引起的(举例:例如从dev分支合并到master分支的PR),这种情形下,需要将两个分支pull到本地, 进行手工筛选,将master合并到dev分支,将更新后的dev分支推送到远程仓库,之后再提交pull request,如没有提示无法自动合并,则等待code review之后进行合并。
- git pull显示 fatal: refusing to merge unrelated histories
- 这是由于两个分支之间差异过大导致的,简单的解决方案: git pull xxx --allow-unrelated-histories 之后再手工筛选。
贡献代码
本组织内所有代码仓库均默认master & release为受保护分支,如需进行代码修改或贡献代码,请先fork新的开发者分支后提交pull request,待代码审核通过后并入master分支,测试稳定后投入release分支发布到生产环境。