docs: 为全部代码补充中文注释并加入 AGENTS 注释规范

2026-08-13 22:10:18 +08:00
parent 008261d755
commit af367ed039
1 changed files with 8 additions and 0 deletions
@@ -45,6 +45,14 @@ uv lock              # 仅更新 uv.lock
 - 每个子项目使用 pytest，并在 CI 中启用 `--cov-fail-under=100`，覆盖率不达标视为失败。
 - 新增业务代码时，必须同步补齐覆盖其真实路径的测试。
 ## 代码注释规范
 - 本仓库及所有子仓库的源码（Python、JavaScript、HTML、CSS、TOML 等支持注释的文件）必须配有详细中文注释，说明模块/文件职责、核心类与函数的作用以及关键逻辑，确保后续维护人员无需通读全部实现即可快速理解工作原理。
 - 新增或修改代码时，必须同步补充或更新对应注释；不得删除已有注释。
 - 测试代码同样必须配有中文注释，说明每条测试验证的行为与覆盖的路径。
 - JSON 数据文件（例如 `node.manifest.json`）按 JSON 规范不支持注释，字段语义以 `wov-sdk` 的 `NodeManifest` 模型注释和各子仓库 AGENTS.md 为准；修改 JSON 字段时须同步更新文档。
 - 提交前检查是否为新代码补齐注释，未补注释的代码视为未完成。
 ## 目标运行环境
 - 本服务的最终部署目标是 Linux，通常以 Docker/Kubernetes 容器运行。