docs: 协作规则、工作记录与 research-wiki 文档体系

从产品重构为研究原型的第一步(负责人 2026-10-15:「其其实不需要(至少目前不需要)
是一个工程产品」)。协作环境照 ClinDB-ReviewBench(负责人点名参考)。

- AGENTS.md 为唯一规则,CLAUDE.md 只引用它;硬性约束保留旧项目的答案隔离、各路隔离,
  加上数字可追溯、花钱先报预估等
- WORK_LOG.md 记当前状态与负责人的关键决定
- research-wiki:README、explanation/结构.md(8 个模块、依赖边界、推进顺序)、
  design/0001(为什么重构、继承与放弃什么、单一 uv 环境)、guides/开发环境.md
- 三份新文档过了一轮「硕士生阅读」并按意见修订

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-10-15 23:42:37 -04:00
parent 5eb38df22d
commit 1f7a6a3d9c
13 changed files with 413 additions and 0 deletions
+37
View File
@@ -0,0 +1,37 @@
# 开发环境
读者:第一次在本机搭环境的人。
## 一、前提
- [uv](https://docs.astral.sh/uv/)(Python 包和环境管理工具),本机 `~/.local/bin/uv`。
- Python 3.12:uv 会按 `.python-version` 自动准备,不需要另装。
## 二、同步环境
```bash
make sync # 按 uv.lock 建 .venv 并安装依赖
uv run pre-commit install # 每次提交前跑 gitleaks、本地材料拦截和格式检查
```
## 三、日常命令
| 命令 | 做什么 |
|---|---|
| `make fmt` | ruff 自动修正并格式化 |
| `make test` | 不花钱、不需要显卡的测试 |
| `make check` | lint、格式、类型(pyright strict)、导入边界(import-linter)、测试,依次执行,失败即停 |
需要显卡的测试用 `uv run pytest -m gpu`,花钱的真实模型测试用 `uv run pytest -m live`,都不在 `make check` 里。
## 四、数据和本地材料
以下目录不进 git,新机器上要自己准备:
| 目录 | 从哪来 |
|---|---|
| `data/` | 远程 `wangwenhan@202.38.247.58:CADx-4-CAD/data/` 下的 `交付包_20260908_40例`、`1.2-TEST`,用 rsync 同步 |
| `reference/CADx-4-CAD/` | 旧项目:先 rsync 工作区(排除 `data/`),再 `git fetch` 远程 `CADx-4` 仓库的全部分支恢复历史 |
远程服务器走 `202.38.247.58`,不走 Tailscale 地址 `100.83.164.94`:同一台机器,后者慢几百倍。
| `models/` | MedSAM2 权重,CEUS 迁移的任务书落地后补充来源 |