From af367ed0392646621d116153254118380ff7890e Mon Sep 17 00:00:00 2001 From: cat-shark Date: Thu, 13 Aug 2026 22:10:18 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=B8=BA=E5=85=A8=E9=83=A8=E4=BB=A3?= =?UTF-8?q?=E7=A0=81=E8=A1=A5=E5=85=85=E4=B8=AD=E6=96=87=E6=B3=A8=E9=87=8A?= =?UTF-8?q?=E5=B9=B6=E5=8A=A0=E5=85=A5=20AGENTS=20=E6=B3=A8=E9=87=8A?= =?UTF-8?q?=E8=A7=84=E8=8C=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 4851029..e16bdd5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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 容器运行。