ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

awesome-copilot 中的 AI Readiness Reporter:用 AgentRC 九支柱模型生成仓库 AI 就绪度 HTML 报告

awesome-copilot 中的 AI Readiness Reporter:用 AgentRC 九支柱模型生成仓库 AI 就绪度 HTML 报告 awesome-copilot 中的 AI Readiness Reporter用 AgentRC 九支柱模型生成仓库 AI 就绪度 HTML 报告【免费下载链接】awesome-copilotCommunity-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-copilot本文以 awesome-copilot 仓库中的 ai-readiness-reporter 自定义 Agent 定义 为主体完整讲解该 Agent 的职责边界、八步工作流、AgentRC 五级成熟度模型、九支柱评估体系、评分与严重度分桶规则以及它所依赖的固定 HTML 模板与占位符替换协议。配套的技能与插件定义acreadiness-assess 技能、acreadiness-policy 技能、acreadiness-cockpit 插件用于说明该 Agent 在 Measure → Generate → Maintain 循环中的实际协作关系。读完后你可以理解这个 Agent 如何把一条agentrc readiness --json命令的输出转化为一份可离线打开、自包含的静态 HTML 就绪度仪表盘reports/index.html。Agent 的定位AgentRC 循环中的 Measure 步骤Agent 的 frontmatter 声明了它的基本身份name: ai-readiness-reporter description: Runs the AgentRC readiness assessment on the current repository and produces a self-contained, static HTML dashboard at reports/index.html. ... argument-hint: Run a full AI-readiness assessment, optionally with a policy file (e.g. examples/policies/strict.json). ... tools: [execute, read, search, search/codebase, editFiles] model: Claude Sonnet 4.5它的角色设定是 AI-readiness analyst对当前仓库执行AgentRC CLI解释每一个结果并产出单个自包含的reports/index.html——不依赖任何服务器无外部 CSS/JS、无框架、所有资源内联用file://协议直接打开即可渲染。它运行在一个明确的心智模型里Measure → Generate → Maintain。AgentRC 先度量仓库的 AI 就绪程度再生成弥补缺口的文件并伴随代码演进帮助维持质量。该 Agent 只负责Measure环节并把产出物指向Generate环节即generate-instructions技能 /ai-readiness-reporter工作流。从仓库结构看这一分工由 acreadiness-cockpit 插件 完整承载插件中的三个技能分别对应循环的三步——技能循环步骤职责/acreadiness-assessMeasure运行就绪度扫描并移交ai-readiness-reporter渲染 HTML 仪表盘/acreadiness-generate-instructionsGenerate包装agentrc instructions默认输出.github/copilot-instructions.md/acreadiness-policyMaintain选择、脚手架化或应用 AgentRC 策略前置条件是Node.js 20在 PATH 上AgentRC 的硬性要求以及在 VS Code 中启用 Copilot agent 插件——这一点在 acreadiness-cockpit 插件说明 与 acreadiness-assess 技能 中均被强调If unsure, runnode --version。八步工作流从政策检测到报告确认Agent 定义文件中的 Workflow 一节给出了完整的执行序列每一步都有明确的约束。1. 检测策略Policy文件如果用户在对话中引用了策略文件如policies/strict.json、examples/policies/ai-only.json、--policy org/agentrc-policy-strictAgent 需要捕获它否则默认无策略运行。策略是 AgentRC 评分体系的定制手段。从 acreadiness-policy 技能 可以看到策略的完整 schema——一个包含三个可选段criteria、extras、thresholds的小 JSON 文件{ name: my-policy, criteria: { disable: [env-example, observability, dependabot], override: { readme: { impact: high, level: 2 }, lint-config: { title: Linter required } } }, extras: { disable: [pre-commit] }, thresholds: { passRate: 0.9 } }AgentRC 还内置了三个示例策略可作为起点strict.json100% 通过率、提升关键标准的影响权重、ai-only.json禁用全部仓库健康检查聚焦 AI 工具链、repo-health-only.json禁用 AI 检查聚焦传统质量维度。策略还支持链式叠加例如npx -y github:microsoft/agentrc readiness --json --policy ./org-baseline.json,./team-frontend.json2. 运行就绪度评估在仓库根目录执行且必须带--json以保证输出可解析npx -y github:microsoft/agentrc readiness --json [--policy path-or-pkg] [--per-area]需要捕获完整的CommandResultTJSON 信封它是后续所有解读与渲染的输入源。3. 读取仓库上下文加载.github/copilot-instructions.md、AGENTS.md、CLAUDE.md、agentrc.config.json以及被引用的任何策略 JSON。这一步的目的是让 Agent 能够精确描述每个支柱的当前状态例如 AGENTS.md 已存在412 行最后修改于 3 周前而不是只复述 CLI 的原始结论。4. 对照成熟度模型与支柱定义解读 JSON每一条建议recommendation都要被映射到三个维度它属于哪个支柱它的影响权重critical5、high4、medium3、low2、info0;它落入哪个分桶Fix First / Fix Next / Plan / Backlog规则见下文严重度矩阵。5. 用固定模板生成reports/index.html产出文件必须满足一组硬性要求单一自包含文件不允许指向网络资源的link或script src所有 CSS 内联在style中不使用任何 JS 框架允许纯原生 JS但可省略用file://直接打开即可正确渲染;把原始 AgentRC JSON 嵌入script typeapplication/json idraw-data块中使报告自描述使用语义化 HTMLheader、section、table等并保证可访问的对比度。6–8. 写入、确认与只读约束创建reports/目录若不存在通过editFiles工具写入文件最后在聊天中确认成熟度等级 名称、总分、得分最低的三个支柱、已应用的策略若有、文件路径并建议下一步 AgentRC 动作通常是agentrc instructions即通过generate-instructions技能补齐 AI Tooling 支柱的缺口。第八条工作流同时是全文最重要的边界约束绝不修改仓库中的任何其他文件。五级成熟度模型等级由 AgentRC 从就绪度得分计算得出Agent 在报告中需呈现完整进度表模板中要求按 L5 → L1 渲染并在当前等级处标注 ◼ You are here等级名称含义1Functional可构建、可测试基础工具链就位2Documented存在 README、CONTRIBUTING、自定义指令文件3StandardizedCI/CD、安全策略、CODEOWNERS、可观测性4Optimized已配置 MCP 服务器、自定义 Agent、AI 技能5Autonomous完整的 AI 原生开发几乎无需人工监督在 CI 中可用--fail-level nn 取 1–5强制最低等级实现就绪度的回归防护。九支柱体系8 个仓库健康支柱 1 个 AI 配置支柱每个支柱都带有一个AI 相关性评级在报告的支柱卡片上以徽章呈现High— 直接决定 AI Agent 生成什么、如何自检Medium— 间接影响 Agent 输出质量Low— 通用工程卫生实践对 AI 杠杆较弱。仓库健康8 支柱支柱AI 相关性检查内容为什么对 AI 重要StyleMediumLinter 配置ESLint/Biome/Prettier、类型检查TypeScript/MypyLint 与类型规则是 Agent 能读取的最显式代码风格。有它们Copilot 生成的代码一次过审没有Agent 只能靠猜惯例PR 就会在风格细节上反复纠缠。BuildHighpackage.json 中的 build 脚本、CI 工作流配置没有构建命令的 Agent 无法自验证。规范的npm run build加上镜像它的 CI 工作流让 Agent 能编译、捕获类型错误、在开 PR 前迭代——这是在我机器上能跑与干净检查之间的区别。TestingHightest 脚本、按域划分的测试脚本测试是 Agent 的自动化质量门。有test脚本就能跑 TDD 循环并证明行为按域划分的测试让它只跑相关部分保持快速。没有测试 Agent 不知道自己何时做完了。DocsHighREADME、CONTRIBUTING、按域 README文档是 Agent 的首要上下文来源。README 解释技术栈CONTRIBUTING 解释流程按域 README 解释局部惯例。文档丰富的仓库Copilot 建议质量显著更好因为模型扎根于真实意图而非从文件名猜测。Dev EnvironmentMediumlockfile、.env.examplelockfile 锁定版本让 Agent 的npm install与 CI 一致.env.example告诉 Agent 存在哪些环境变量而不泄露密钥。二者让 Agent 的本地运行可复现并阻止它杜撰不适用的配置。Code QualityMedium格式化配置Prettier/Biome有格式化配置意味着 Agent 的产物落盘即已格式化——没有 diff 噪声、没有关于空白的评审意见。没有它AI 生成的 PR 会触发淹没真实反馈的风格讨论。ObservabilityLowOpenTelemetry / Pino / Winston / Bunyan当日志/追踪库在依赖图中可见时Agent 会用同样的模式给新代码埋点而不是console.log。杠杆低于文档/测试因为 Agent 只在触及运行时埋点的部分工作中需要它。SecurityLowLICENSE、CODEOWNERS、SECURITY.md、DependabotCODEOWNERS 自动把 AI 生成的 PR 路由给正确的评审人SECURITY.md 与 Dependabot 告诉 Agent 如何处理漏洞报告与依赖升级。对治理重要但很少改变 Agent 日常写的代码。AI 配置1 支柱支柱AI 相关性检查内容为什么重要AI ToolingHigh自定义指令.github/copilot-instructions.md、AGENTS.md、CLAUDE.md、MCP 服务器、Agent 配置、AI 技能仓库与 AI Agent 之间的直接接口——整个模型中杠杆最高的支柱。一份好的AGENTS.md胜过其他所有支柱之和它在同一处告诉 Agent 技术栈、惯例、构建命令、测试命令与评审预期。MCP 服务器与自定义技能则把 Agent 的触手延伸到你的工具中。文档还特别指出在 Level 2 及以上AgentRC 会额外检查指令一致性——当多个指令文件copilot-instructions.md、AGENTS.md、CLAUDE.md等并存时标记分歧并推荐收敛优先保留AGENTS.md。这与 acreadiness-generate-instructions 技能 的收尾建议一致如果用户同时拥有copilot-instructions.md与AGENTS.md建议合并为单一事实来源。Extras信息性检查永不计入分数Extras 是轻量、可选的检查单独一节呈现每一项标记为 ✅ present 或 ◻ missing——绝不能当作失败来呈现Extra检查内容agents-doc存在AGENTS.mdpr-template存在 Pull Request 模板pre-commit配置了 pre-commit 钩子Husky 等architecture-doc存在架构文档策略在报告中的落地规则当存在策略用户指定或agentrc.config.json中配置时Agent 需按四条规则处理在报告顶部展示生效策略名称 路径/包加上由其criteria.disable、criteria.override、extras.disable、thresholds推导出的简短摘要过滤报告以反映被禁用的 criteria/extras不把它们列为缺口尊重 override——分桶时使用 override 的impact与level而非默认值呈现阈值——若设置了thresholds.passRate将实际通过率与之对比显著展示 pass/fail。若没有策略则该小节标注 Default policy (built-in defaults)并链接到 AgentRC 的内置示例strict.json、ai-only.json、repo-health-only.json。在 CI 侧策略与--fail-level组合使用例如- run: npx -y github:microsoft/agentrc readiness --policy ./policies/strict.json --fail-level 3评分与严重度分桶评分参考Impact权重critical5high4medium3low2info0Score 1 - (总扣减分 / 最大可能权重)。等级换算A ≥ 0.9B ≥ 0.8C ≥ 0.7D ≥ 0.6F 0.6。分桶矩阵桶判定规则Fix Firstimpact ∈ {critical, high}且修复代价小单文件或配置Fix Nextimpact medium且修复代价小Planimpact medium且需要较大重构⚪Backlogimpact ∈ {low, info}当拿不准时若支柱是Docs、Testing、Build或AI Tooling则优先归入更高桶——它们是 AI Agent 杠杆最高的支柱。HTML 模板协议DO NOT IMPROVISE报告的视觉呈现是固定的且被所有该插件的消费者共享。规范模板作为acreadiness-assess技能的捆绑资源随附report-template.html。Agent 必须用read工具从插件根读取report-template.html将每个{{placeholder}}替换为 AgentRC JSON 中的具体数据带标记的块支柱卡片、计划行、成熟度行、Extras 行按条目重复若无生效策略则整体删除Active Policy小节用editFiles把替换结果写入reports/index.html缺失则先建目录。模板文件自身的头部注释report-template.html 开头的块注释把同样的规则写成了机器可读的契约并列出全部占位符正文部分则展示了报告的实际结构What is AI Readiness 说明段、三格 KPI 面板Maturity / Overall Score / Pass rate、Maturity Progression 表、Active Policy 节、Repo Health / AI Setup 两组支柱卡片网格、Extras 表、Prioritised Remediation Plan// 三张表、Next Steps 有序列表以及末尾的 Raw AgentRC JSONdetails折叠区与script typeapplication/json idraw-data内嵌块。硬规则不得偏离不得改动 HTML 结构、类名、CSS 变量或style块不得添加标签页、开关、主题切换、深浅色变体或额外导航——报告是单一统一视图不得引入外部 CSS、字体、JS 框架或统计脚本——文件必须file://可开、零网络依赖必须保留内嵌的script typeapplication/json idraw-data…/script块使报告自描述。占位符清单全局占位符未标注可选均为必填占位符来源{{repoName}}仓库名文件夹名或 git remote{{date}}报告生成的 ISO 日期{{level}}/{{levelName}}成熟度等级数字 名称{{overallPct}}/{{grade}}总体得分整数百分比 字母等级{{passRate}}/{{threshold}}通过率 vs 策略阈值完整格式化如85%N/A 时为—字面量%属于被替换值而非模板{{policyName}}/{{policySummary}}仅在策略生效时否则整段省略 policy 小节{{rawJsonCompact}}/{{rawJsonPretty}}内嵌的 AgentRC JSON 信封每支柱占位符.pillar块按支柱重复一次占位符来源{{pillarName}}Style、Build、Testing……{{pillarScore}}该支柱的整数百分比{{pillarStatus}}good/warn/bad驱动进度条 圆点颜色{{pillarRelevance}}high/medium/low——取自上文支柱表{{pillarWhat}}AgentRC 对该支柱检查的内容{{pillarWhyAi}}支柱表中的完整段落不能是一句话{{pillarCurrent}}具体的当前状态如 ESLint 配置存在2 个警告{{pillarRecommendation}}需要新增或编辑的具体文件/配置转义协议安全关键模板协议对每个被替换值都要求先转义再插入所有进入 HTML 正文或属性值的{{placeholder}}替换如{{repoName}}、{{pillarCurrent}}、{{pillarRecommendation}}、{{policySummary}}、{{rawJsonPretty}}必须做 HTML 转义、、、、{{rawJsonCompact}}位于script typeapplication/json块内部规则相反只把其中的/script子串替换为\/script以防止脚本标签被提前闭合不得做 HTML 转义——JSON 必须保持合法绝不允许未经转义地插入原始用户可控字符串文件名、commit message、建议文本。一个文件名里含img onerror…的仓库绝不能在报告中产出可执行 HTML。十条运行规则Agent 的行为边界定义文件末尾的 Operating Rules 是整个 Agent 的宪法永远运行agentrc readiness --json——绝不虚构数据永远通过捆绑的report-template.html渲染——加载模板、替换占位符、写入reports/index.html不要从零手写 HTML解释每个支柱——使用支柱表中的完整段落加上当前状态与具体建议禁止一句话带过为每个支柱标注 AI 相关性high/medium/low使徽章与表格一致把每个 Repo Health 发现都关联到 AI 影响——这里的仓库健康不是泛泛的 DevOps而是透过它如何帮助 Copilot 与其他 Agent来表述尊重策略——策略在作用域内时把其 disable/override/threshold 规则反映到渲染结果中Extras 单独展示——永不计入分数永不列为缺口用 AgentRC 循环框定下一步——Measure本报告→ Generateagentrc instructions→ MaintainCI 的--fail-level只写reports/index.html——不修改任何其他文件目录缺失则创建不许废话——报告中的每个段落都必须承载具体信息。实际使用方式按 acreadiness-cockpit 插件 的用法说明在 Copilot 聊天中可以直接这样驱动整个循环/acreadiness-assess # Measure → 产出 reports/index.html /acreadiness-assess --policy ./policies/strict.json # 带策略的评估 ai-readiness-reporter # 直接唤起本文主角 Agent报告产出后插件给出的后续动作依次是运行agentrc instructions --output .github/copilot-instructions.md或使用generate-instructions技能生成或刷新指令文件、逐项处理 Fix First 清单并重跑报告确认分数提升、用 JSON 策略固化组织标准、以及在 CI 中接入agentrc readiness --fail-level n防止就绪度回退。值得注意的是AgentRC 本身也内置了一个 HTML 渲染器--visual/--output report.html但 acreadiness-assess 技能 明确说明其输出刻意保持通用本 Agent 的价值恰恰在于通过固定模板 完整支柱解读产出更贴近代码评审风格的定制仪表盘而非指标转储。小结ai-readiness-reporter 是 awesome-copilot 仓库中一个典型的流程固化型自定义 Agent它把 AgentRC 的 Measure 步骤压缩成一份可复现的协议——固定数据源agentrc readiness --json、固定评估模型9 支柱 × 5 等级 × 5 级权重、固定呈现report-template.html占位符替换 强制转义、固定边界只写reports/index.html。理解这份定义文件也就理解了如何用 Copilot 自定义 Agent 把一条 CLI 命令的输出稳定地转化为团队可分享、可归档、可回归检查的就绪度资产。【免费下载链接】awesome-copilotCommunity-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.项目地址: https://gitcode.com/GitHub_Trending/aw/awesome-copilot创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表