Always respond in 中文
- 各部分功能尽量低耦合,高内聚。
- 各个函数代码做好注释。
- 有完备的日志系统,方便后期调试确认问题。
- 避免写冗余代码,提高项目的可复用性。
- 尽力遵循工程上的最佳实践。适当使用文件夹来增加整个项目的可读性,但不要添加过多无关文件。
- 及时完善 .gitignore 文件。
- 涉及多平台运行时,请考虑文件编码问题。尤其是 requirements.txt 文件。
- 所有测试脚本的在 console 里的日志输出禁止出现 emoji 和中文,请使用纯英文。
- 如果是 python 项目,记得配置虚拟环境并在虚拟环境中运行代码。
- 尽量保证编程语言的唯一性,避免多种编程语言混杂,比如 C++ 和 python 混杂。
- 设计项目时需要考虑全平台的兼容性,注意文件路径和文本编码。
- 完成一系列代码修改后,务必进行类型检查
- 出于性能考虑,优先运行单个测试,而非整个测试套件
- 所有 test 项目请置于 tests 文件夹里面运行,适当创建子文件夹以提升项目可读性。禁止在其他文件夹里放 test 脚本。