回购指导同步

设计与多媒体 社区

技能解读

当前原文的自动摘译,尚未人工审校。

概述

使用此技能来决定在代码、设计或产品更新后必须更改哪些文档,然后在正确的文件中进行这些编辑,并通过可验证的链接返回到源行为。

工作流程

识别变化面。检查差异、触及的包、新命令、配置标志、UI 行为、API 形状、CRD、生成的架构、部署清单和测试。如果更改影响设置、CLI 工作流程、操作员协调、入口/网关行为、身份验证/策略、注册表/映像处理、可观察性或缓存模式假设,请在编辑文档之前在 test/e2e/kind.sh 或相邻集成测试中确定匹配的 E2E 场景。

AGENTS.md 规则

当更改影响未来代理或贡献者在存储库中的工作方式时,更新 AGENTS.md。充分的理由包括新的必需检查、更改的设置命令、新的故障模式、更改的存储库布局、新的服务所有权、更改的 CLI 工作流程或新的操作安全规则。请勿将产品营销、详尽的 API 参考、发行说明或临时 PR 上下文放入 AGENTS.md 中。而是链接或总结稳定的文档。

输出标准

完成后,总结一下: docs 和 AGENTS.md 文件更改了源行为 每次更新都反映了验证运行,包括搜索过时的术语 已知的文档空白 故意留下的空白

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
设计与多媒体
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@tomevault-io · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
即装即用
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 读取环境变量
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

作者说明文件(原文) SKILL.md

# Repo Guidance Sync

## Overview

Use this skill to decide what documentation must change after a code, design, or product update, then make those edits in the right files with verifiable links back to source behavior.

## Workflow

1. Identify the change surface.
   - Inspect the diff, touched packages, new commands, config flags, UI behavior, API shapes, CRDs, generated schemas, deployment manifests, and tests.
   - If the change affects setup, CLI workflows, operator reconciliation, ingress/gateway behavior, auth/policy, registry/image handling, observability, or cache-mode assumptions, identify the matching E2E scenario in `test/e2e/kind.sh` or adjacent integration tests before editing docs.
   - Search for existing docs before adding new files: `rg -n "<command|field|feature|concept>" README.md AGENTS.md docs website config api internal services`.
   - Prefer updating the nearest existing guide, reference, or runbook over creating a new document.

2. Classify required doc updates.
   - User-facing product change: update README, docs guides, CLI examples, API/reference pages, screenshots or UI copy references if present.
   - Developer workflow change: update AGENTS.md, build/test instructions, local setup notes, failure modes, environment variables, or repo map entries.
   - Codebase architecture or contributor-flow change: review `docs/internals/` and decide whether the overview, package tours, or Mermaid diagrams need updates. Add or revise diagrams only when they clarify package boundaries, request flow, reconciliation flow, service interactions, or contributor decision points.
   - Design change: update design-system rules, component guidance, UX behavior notes, or docs that describe screens/workflows.
   - Operational change: update install, deployment, TLS, registry, Kubernetes, observability, and rollback/debug instructions.
   - Schema/contract change: update CRD/API docs, examples, generated docs if the repo owns them, and any golden snapshots tied to CLI help.
   - E2E-visible behavior change: update or add the relevant E2E assertion in `test/e2e/kind.sh` when the behavior is exercised through Kind, real MCP traffic, policy/session state, OAuth, observability, registry/image paths, or `cluster doctor`. If narrower unit/integration coverage is sufficient, note why in the final validation summary.

3. Verify source truth before writing.
   - Treat code, tests, CRD types, OpenAPI specs, CLI definitions, workflow files, and manifests as source of truth.
   - For commands and examples, confirm exact flags, defaults, resource names, paths, and environment variables from implementation.
   - Avoid inventing roadmap promises or behavior not present in code unless the user explicitly asks for planned-product wording.

4. Edit with the right scope.
   - Keep docs concise and task-oriented; remove stale claims instead of layering caveats.
   - Preserve the repo's voice, terminology, command style, and existing document structure.
   - For `docs/internals/`, prefer updating the nearest existing walkthrough, mental model, or diagram over adding a new page. Use diagrams for relationships and flows, not for listing files that a table can express more clearly.
   - Update AGENTS.md only for durable contributor or agent guidance, not one-off implementation details.
   - Keep examples copy-pasteable: include required tags, namespaces, paths, auth headers, and prerequisite environment variables.
   - Update links and table-of-contents entries when adding or renaming pages.

5. Validate.
   - Run the narrowest relevant checks: markdown/docs build if available, golden tests for CLI help changes, generated-doc drift checks when docs are generated, E2E scenario checks for behavior covered by `test/e2e/kind.sh`, and targeted code tests if examples exercise behavior.
   - At minimum, run searches for old field names, commands, or stale wording that the change replaces.
   - If validation cannot be run, state the blocker and what was manually checked.

## AGENTS.md Rules

Update AGENTS.md when a change affects how future agents or contributors should work in the repo. Good reasons include new required checks, changed setup commands, new failure modes, changed repository layout, new service ownership, changed CLI workflows, or new operational safety rules.

Do not put product marketing, exhaustive API reference, release notes, or transient PR context in AGENTS.md. Link or summarize stable docs instead.

## Output Standard

When finished, summarize:
- docs and AGENTS.md files changed
- source behavior each update reflects
- validation run, including searches for stale terms
- known doc gaps left intentionally open

---
> Source: [Agent-Hellboy/mcp-runtime](https://github.com/Agent-Hellboy/mcp-runtime) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-05-23 -->

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。