把"数据类型必须明确"从口头要求变成仓库规则,每个函数都适用。 - 判断顺序表:整数用 (int, np.integer)、浮点用 (float, np.floating)、 bool 要放在 int 判断之前、数组先 np.asarray 归一化 - 硬规则:非法类型必须 raise TypeError,不许静默兜底 (静默的后果是"种子被忽略、结果不可复现且无提示",最难查) - 要求每个公开函数写全 Parameters(含 None 走哪条分支)与 Raises - docs/03-roadmap.md §3.2 开发纪律加一行指针
文档索引
本目录是 MCM/ICM Toolkit 的需求、架构、方案与开发规范的唯一落盘处。
| 文档 | 内容 |
|---|---|
| 01-suggestion-review.md | 对 ChatGPT 建库建议的审查与精简:留什么、砍什么、补什么 |
| 02-architecture.md | 精简后的包结构、边界划分、统一接口约定 |
| 03-roadmap.md | 功能清单分级(L0 / L1 / L2 / 不做)与开发纪律 |
| 04-environment.md | conda / venv 环境配置、镜像、离线约束 |
| dev/function-card-template.md | S 档算法的「函数卡片」模板 |
| 05-git-workflow.md | Git 工作流、Gitea 远程(SSH 走 Tailscale)、行尾策略 |
| dev/personal-pitfalls.md | 个人易错点清单:只追加,追加前不通读 |
阅读顺序
- 先读
01-suggestion-review.md—— 它决定后面所有事。 - 再读
02-architecture.md—— 它决定代码往哪写。 - 开工前读
03-roadmap.md的对应条目 —— 它决定这次做什么、做到什么程度。 - 环境出问题看
04-environment.md。
项目级进度看根目录的
STATUS.md;本目录只放不会频繁变的内容。