历史遗留问题¶
本文件记录影响发布质量、但不应该混入其他功能开发的清理任务。后续 agent 在执行
specs/tasks.md 中对应任务前,必须先阅读本文件。
程序文件必须只使用英文¶
MPSBoost v2 及之后的程序文件中不得包含中文文本。范围包括源码、测试、构建脚本、包 元数据、生成代码模板、运行时错误消息、docstring、行内注释和测试名称。
文档文件不受本清理规则限制。README 文件、specs/、项目规划文档以及未来双语站点
内容可以继续保留中文。本规则的目标是让已安装代码、日志、异常和开发者 API 对国际
用户保持一致,同时保留中文项目规划材料。
搜索范围¶
agent 必须只搜索程序文件。不要把 specs/、README.md、README.zh-*、Markdown
文档或站点内容中的中文视为本任务失败。
使用以下命令查找常见程序文件中的中文字符:
rg -n "[\u4e00-\u9fff]" \
src tests scripts include CMakeLists.txt pyproject.toml \
-g '*.py' -g '*.cpp' -g '*.hpp' -g '*.h' -g '*.mm' -g '*.metal' \
-g '*.cmake' -g 'CMakeLists.txt' -g '*.toml' -g '*.sh' -g '*.yml' -g '*.yaml'
如果后续新增了程序目录,必须扩展这条命令的搜索范围,而不是手工逐个文件检查。
处理要求¶
- 面向用户的运行时错误必须翻译为清晰英文。
- 代码注释必须翻译为简洁英文,只保留能帮助维护者理解非显然逻辑的注释。
- docstring、测试说明和断言消息必须翻译为英文。
- 必须保持行为完全一致;本任务是文本清理,不是逻辑重构。
- 不得削弱测试、跳过测试、删除断言,或修改数值期望来让清理通过。
- 不得仅因为文档中包含中文就修改文档。
完成标准¶
只有满足以下条件时,才能把对应任务标记为完成:
- 上面的搜索命令在程序文件中没有中文命中。
- 本文件写成之后新增的程序目录也已经纳入搜索。
- 覆盖被修改模块的聚焦测试已经通过。
- 最终 commit 只包含翻译和注释清理;除非明确获批,否则不得夹带行为变更或构建改动。