已合并
fix(ops): rename reference/ to references/ to comply with STANDARDS.md #646
fix(ops): rename reference/ to references/ to comply with STANDARDS.md #646
已合并
yanhaifeng5创建于 17 天前
yanhaifeng5
yanhaifeng5成员
17 天前

描述

本 PR 落实 docs/STANDARDS.md 关于 Skill 参考目录须使用复数 references/ 的规范,将不符合规范的 4 个 skill 的 reference/ 目录统一重命名为 references/,并新增测试看护防止回退。

docs/STANDARDS.md 规定 Skill 内参考目录名为 references/(复数),但以下 4 个 skill 使用了单数形式 reference/,不符合规范。本次统一重命名并同步更新内部链接:

Skill 原目录 新目录 重命名文件数 SKILL.md 链接更新
ops/ascendc-performance-best-practices reference/ references/ 66 20 处
ops/cann-env-setup reference/ references/ 1 3 处
ops/ops-precision-standard reference/ references/ 7 7 处
plugins-community/cannbot-knowledge/skills/ops-knowledge-ingest reference/ references/ 3 7 处

共 85 个文件重命名(git mv,保留文件历史),4 个 SKILL.md 同步更新内部链接。其中 ops-knowledge-ingest 为主线新增 skill,同样使用了单数形式;重命名时保留知识库 reference/ 概念树名称不变(仅重命名本地参考目录,知识库树名是另一语义)。

测试看护

tests/lib/skill_validator.py — 新增 3 条结构规则:

  • S-STR-19(error):禁止单数 reference/ 目录,须为 references/(同时检查 asset/assets/script/scripts/
  • S-STR-20(warn):evals/ 目录结构检查(兼容主线 evals.md→evals.json 迁移,降级为 warn)
  • S-STR-21(warn):scripts/*.sh 须可执行

tests/behavior/install/test-init-behavior.sh — 新增 git 分支保护守卫:测试前记录当前分支,测试后检测并恢复被 init.sh 误切换的分支,防止测试污染开发者工作区。同时为 fake repo 初始化真实 git 仓,避免 init.sh 的 git 操作穿透到父仓。

tests/unit/skills/test-structure.sh + tests/README.md — 同步 3 条新规则文档。

关联的Issue

无特定 Issue。本 PR 落实 docs/STANDARDS.md 第 265 行关于 references/ 目录命名的规范要求。

测试

  • tests/unit/skills/test-structure.shPASSED
    • 结构检查:166/166 通过
    • SKILL.md 链接:166/166 通过
    • Skill 名称唯一性:通过
  • git diff --check:通过(无空白错误)

文档更新

  • 4 个 skill 的 SKILL.md 内部链接同步更新为 references/ 路径
  • tests/README.md:补充 S-STR-19/20/21 规则说明

类型标签

  • 🌟 新特性
  • ✨ 特性增强
  • 🐛 Bug 修复
  • ⚡ 性能优化
  • 🧪 测试用例
  • 📦 构建 / CI
  • 📝 文档更新
  • 🔧 配置变更
  • ⬆️ 依赖升级
  • 🔒 安全修复
  • ♻️ 代码重构
  • 🧹 代码清理
  • ❓ 其他,请描述:

流水线故障排查

UT_Test 未通过?
请在下方流水线表格的 UT_Test 行,点击右侧的 >>>>> 下载 CANNBot-skills UT 测试报告(HTML 格式)。
打开报告后,展开页面中的「UT Test 失败修复指南」,复制其中的提示词并粘贴给 Agent,Agent 将根据日志自动定位并修复问题。

示例:
UT_Test下载示例

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 yanhaifeng5 的贡献)
atomgit-bot
atomgit-bot
17 天前 评论:

变更摘要

本次 PR 主要将 ops/ascendc-performance-best-practices/ 下的 reference/ 目录重命名为 references/,以符合 STANDARDS.md 规范。同时,在测试脚本 test-init-behavior.sh 中新增了 Git 分支防护机制,防止因 init.sh 的 Git 操作泄漏到父级仓库而导致测试环境被意外修改。

主要改动

  • 目录重命名 reference/references/:将 ops/ascendc-performance-best-practices/reference/ 下所有文件(包括 broadcast/code/reduce/templates/ 子目录中的 .cpp.h.template 文件)整体迁移至 references/ 目录,内容无变化,仅调整目录命名以遵循 STANDARDS.md 规范。

  • setup_fake_repos 新增 Git 仓库初始化:在创建虚假仓库时,增加了 git initgit addgit commit 操作,使虚假目录成为真正的 Git 仓库。这样 init.sh 中的 git checkout 等命令会作用于该虚假仓库,而非穿透到父级 cann_skills 仓库。

  • main 函数新增分支守卫机制:测试开始前记录 SKILLS_DIR 的当前 Git 分支(guard_branch),所有测试完成后检查分支是否被意外切换;若分支发生变化,输出错误信息并自动恢复原分支,同时将此次检测计入失败计数(FAIL_COUNT)。

likedislike
不准确?
此处折叠了113条消息 查看更多
CANN-robotCANN-robot成员
10 天前 添加了label:approved
jon_jin成员
10 天前 评论:

/lgtm

likedislike
CANN-robotCANN-robot成员
10 天前 添加了label:lgtm
CANN-robotCANN-robot成员
10 天前 关闭了关联的issue
CANN-robotCANN-robot成员
10 天前 合入了pull request