project-conventions.mdc 1.0 KB

1234567891011121314151617181920212223242526272829303132333435
  1. ---
  2. description: 项目通用约定(中文回复、conda 环境)
  3. alwaysApply: true
  4. ---
  5. # 项目约定
  6. ## 语言
  7. - 与用户的所有对话、说明、总结、PR/提交说明草稿均使用**简体中文**。
  8. - 代码标识符、路径、命令、日志原文可保持英文;技术术语首次出现时可附简短中文说明。
  9. ## Python / Shell 环境
  10. 本项目使用 Conda 环境 **`mineru`**。执行 Python、pip、pytest 或依赖项目依赖的命令前,必须先激活该环境。
  11. ### 交互式终端
  12. ```bash
  13. conda activate mineru
  14. ```
  15. ### 非交互式命令(推荐,避免 activate 未生效)
  16. ```bash
  17. conda run -n mineru python ...
  18. conda run -n mineru pip ...
  19. conda run -n mineru pytest ...
  20. ```
  21. ### 要求
  22. - 不要假设系统默认 `python3` 已安装项目依赖(如 `bs4`、`torch` 等)。
  23. - 若命令失败且提示缺少模块,先确认是否在 `mineru` 环境中再排查代码问题。
  24. - 新建脚本或文档中的示例命令,应体现 `conda activate mineru` 或 `conda run -n mineru`。