贡献指南

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

指导原则

• 本项目中的代码应该是可靠的

  • 有测试的可靠代码

  • 可工作的可靠代码

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

• 我们应该互相帮助，共同实现当前最佳水平（SOTA）

• 我们应该编写清晰的代码

  • 代码不应冗余

  • 代码应包含内嵌文档（遵循标准 pep 格式）

  • 代码应组织成类和函数

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

• 我们共同协作，沟通时应友善、耐心、清晰。不欢迎粗暴无礼的行为。

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

接受 PRs

• 你发现了一个 bug 并找到了修复方法

• 你为本项目协调员优先处理的 issue 贡献了解决方案

• 你新增了功能，并且已经为此功能撰写了 issue、文档和测试

PR 指南

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

• 请引用或撰写并引用一个 [issue](https://guides.github.com/features/issues/)

• 请使用清晰的提交信息

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

• 请尽量不要破坏现有功能，如果必须破坏，请计划好如何解释其必要性并与协作者协调

• 请耐心并尊重地对待反馈意见

• 请使用 pre-commit 钩子

其他

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

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

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