Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.07 KB

File metadata and controls

22 lines (15 loc) · 1.07 KB

虚拟环境

  • 本项目用 uv 管理虚拟环境,任何 python 相关的命令需通过 uv 来运行
  • 禁止使用全局的 python 或 python3

代码风格

  • 新写的代码或修改后的代码要用 pylint 检查,不要引入新的警告

文档与测试

  • 新写的代码或修改后的代码要用 pytest 测试,不要引入新的警告
  • 文档在 docs/ 中,每次更新代码时,需要更新文档
  • 测试在 tests/ 中,每次更新代码时,需要更新测试
  • 较大的子模块,如 auto、storage、math 等,需要单独编写文档和测试,文档在 docs/ 中建立同名子目录,并在其中编写文档,测试在 tests/ 中建立同名子目录,并在其中编写测试
  • 除非有破坏性变更,否则不要修改已有的测试
  • 动手前先阅读对应模块的文档,了解当前的实现与设计思路
  • 开发复杂模块总结的经验教训记录在对应模块文档目录下的 lessons.md 文件中,及时阅读并更新该文件,该文件保持简洁。

本地设置

  • 请遵循 @./CLAUDE.local.md 中的指令