Prhub

#5846 [misc] feat: add agent instructions, skills & improve CI for easier tests

原始 PR 作者 tongyx361 合并时间 2026-04-01 22:09 文件变更 17 提交数 33 评论 5 代码增减 +335 / -41

执行摘要

添加 AI 代理指令框架并整合 CI 检查到 pre-commit,支持代理辅助开发。

动机是支持AI代理(如Claude Code、Codex)参与项目贡献,通过提供标准化指令和整合本地验证,提高开发效率和代码质量。PR body中明确提到目标是“add a framework-agnostic agent instruction system for AI coding agents”和“consolidate sanity checks into pre-commit to form an initial closed loop for agent-assisted development”。

建议技术管理者阅读AGENTS.md了解代理贡献政策,工程师关注.pre-commit-config.yaml的更改以适配本地开发环境。此PR值得精读,因为它展示了如何构建框架无关的代理指令系统和整合CI检查的设计决策。

讨论亮点

review中,gemini-code-assist[bot]指出了两个关键问题:一是AGENTS.md中仓库路径应为“volcengine/verl”而非“verl-project/verl”,以匹配实际项目位置;二是建议CLAUDE.md使用更明确的指令确保代理读取AGENTS.md,如添加“You must read and strictly adhere to the project-wide agent instructions defined in AGENTS.md.”。这些建议被采纳以修复路径错误和提高指令明确性。

实现拆解

实现分为两部分:一是代理指令系统,添加了AGENTS.md(项目范围规则)、.agent/skills/目录(共享技能如pr.md和issue.md)、CLAUDE.md(Claude入口点)以及相关文档(如docs/contributing/editing-agent-instructions.md);二是CI改进,将多个健全性检查从.github/workflows/sanity.yml迁移到.pre-commit-config.yaml中,并更新了tests/special_sanity/check_license.py以使用git ls-files尊重.gitignore,同时在cpu_unit_tests.yml、gpu_unit_tests.yml和npu_unit_tests.yml中排除tests/special_sanity/路径过滤。

文件 模块 状态 重要度
AGENTS.md docs added 8.0
.pre-commit-config.yaml ci modified 7.0
.github/workflows/sanity.yml ci modified 6.0
tests/special_sanity/check_license.py tests modified 5.0

关键符号

_git_tracked_py_files get_py_files

分析完成后,这里会展示 LLM 生成的相对完整源码片段和详细注释。

评论区精华

仓库路径错误 正确性

gemini-code-assist[bot] 指出 AGENTS.md 中仓库路径应为 'volcengine/verl' 而非 'verl-project/verl',以匹配实际项目位置,否则 gh 命令将失败或返回错误结果。

结论:建议修复路径,确保代理执行的命令正确。 · 已解决

CLAUDE.md 指令明确性 设计

gemini-code-assist[bot] 建议 CLAUDE.md 使用更明确的指令,如添加强制的读取要求,以确保代理加载并遵守 AGENTS.md 中的规则,避免违规导致自动封禁。

结论:建议添加明确指令以提高代理合规性。 · 已解决

风险与影响

风险包括:代理指令可能不完整或过时,导致代理行为不一致;CI更改可能引入回归,例如.pre-commit-config.yaml中添加的新钩子(如check-docs-time-info、check-device-api-usage)需要验证兼容性,或测试过滤错误导致遗漏检查;check_license.py的更改可能遗漏未被git跟踪的文件,影响许可证检查完整性。此外,AGENTS.md的规则需要持续维护,增加文档负担。

对团队影响显著:开发流程更标准化,代理贡献更可控,提高效率;但对代理和贡献者增加了学习曲线。系统层面,pre-commit验证更全面,但可能增加本地运行时间;CI流程简化,减少重复检查。用户无直接影响,但长期看代码质量提升。

路径错误需修复 CI 配置变更风险 文档维护负担

关联 Issue

未识别关联 Issue

当前没有检测到明确关联的 Issue 链接,后续同步到相关引用后会出现在这里。

完整报告

参与讨论