Преглед на файлове

feat(新增项目通用约定文档): 创建项目通用约定文档,明确使用简体中文进行交流及命令执行时需激活`mineru`环境的要求,提升项目规范性与可维护性。

zhch158_admin преди 2 дни
родител
ревизия
55ca99c249
променени са 1 файла, в които са добавени 35 реда и са изтрити 0 реда
  1. 35 0
      .cursor/rules/project-conventions.mdc

+ 35 - 0
.cursor/rules/project-conventions.mdc

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