贡献指南

该项目旨在为交易社区带来一个强化学习环境。 社区中总是存在相互竞争的优先事项，我们希望确保我们能够共同实现一个可靠、可持续且可维护的项目。

指导原则

• We should have reliable codes in this project

  • 带有测试的可靠代码

  • 可靠的代码，运行良好

  • 可靠的代码运行时不消耗过多资源

• 我们应该互相帮助，共同实现SOTA结果

• We should write clear codes

  • 代码不应冗余

  • 代码应该有内联文档（标准pep格式）

  • 代码应该被组织成类和函数

• 我们应该在合理的情况下利用外部工具

• 我们共同努力，沟通时保持友善、耐心和清晰。不欢迎粗鲁的人。

## 如果你看到了什么，就说出来！ * 提交一个[问题](https://guides.github.com/features/issues/)是帮助改进项目的好方法

接受PRs

• 你发现了一个错误并找到了修复的方法

• 您对一个被本项目协调员优先处理的问题做出了贡献

• 您有新增的功能，已经为其编写了问题，并且有文档和测试。

PR 指南

• 请在每次PR中标记@bruceyang、@spencerromo或@xiaoyang。（附注：我们正在寻找更多有软件经验的合作者！）

• 请参考或编写并参考一个[问题](https://guides.github.com/features/issues/)

• 请确保提交信息清晰

• 请为每个新增的功能编写详细的文档和测试

• 请尽量不要破坏现有功能，或者如果必须这样做，请计划证明这一必要性并与协作者协调。

• 请耐心并尊重地提供反馈

• 请使用预提交钩子

其他

-使用 pre-commit ` pip install pre-commit pre-commit install `

-运行测试 ``` -本地 python3 -m unittest discover

-Docker ./docker/bin/build_container.sh ./docker/bin/test.sh ```