Repository Onboarding Flow 用于把新的代码仓库接入一个受管生态系统,使仓库具备一致的结构、治理规则与文档标准。它把接入过程拆解为五个阶段:搭建脚手架、配置、编写文档、集成、验证。
用途与流程概览
接入检查表按阶段推进:阶段一脚手架创建仓库、设定结构、添加许可证;阶段二配置 seed.yaml 契约、CI/CD、代码检查与测试;阶段三编写 README.md、CLAUDE.md、CONTRIBUTING.md 与架构文档;阶段四在系统中注册仓库、加入注册表、连线依赖与事件订阅;阶段五执行验证,包括陌生人测试、CI 通过,最终达到可晋升状态。
阶段一:搭建脚手架
资料提供了一个 bash 脚本示例,接收仓库名与 organ 参数,创建目录并执行 git init,生成 README.md、LICENSE、.gitignore 等核心文件,并建立 src、tests、docs、.github/workflows 等标准目录,同时写入面向 Python 项目的 pyproject.toml 默认配置,其中包含构建后端、项目元数据、开发可选依赖(pytest、ruff)、ruff 行长度与目标版本、以及 pytest 测试路径。资料还给出 .gitignore 示例,覆盖 Python 缓存、环境变量文件、IDE 目录、操作系统文件与构建产物。
阶段二:配置
seed.yaml 契约示例包含 schema_version、repo、organ、tier、promotion_status 字段,并通过 produces 声明本仓库产生的事件(如 repo.created),通过 consumes 声明消费的事件来源(如 orchestration-start-here 的 governance.updated),还可声明 ci 任务(如 lint-test,触发条件为 push,agent 为 github-actions)。CI/CD 部分给出 .github/workflows/ci.yml 示例,在 push 与 pull_request 时运行,使用 Python 3.11 与 3.12 矩阵,步骤包括检出代码、设置 Python、安装开发依赖、运行 ruff check 与 pytest。预提交钩子示例使用 ruff-pre-commit 与 pre-commit-hooks,执行 ruff 修复与格式化、去除行尾空白、修复文件末尾、检查 YAML 与 JSON、检测私钥。
阶段三:编写文档
README 模板包含仓库名、一句话描述、快速开始(前置条件、安装、用法)、架构说明、开发命令与系统上下文(organ、tier、status)。CLAUDE.md 模板包含仓库概述、开发命令、架构说明与关键约束。
阶段四:集成
资料提供了一个注册函数示例:读取注册表 JSON,校验 name、organ、tier 等最小字段,将仓库追加到 registry 的 repos 列表并写回。依赖连线部分说明在 seed.yaml 中通过 consumes 声明依赖来源事件,通过 produces 声明本仓库产生的事件。
阶段五:验证
资料给出 validate_onboarding 函数示例,检查 README.md、LICENSE、.gitignore、seed.yaml 等核心文件是否存在,校验 seed.yaml 是否包含 schema_version、repo、organ、tier、promotion_status 字段,检查是否存在 CI 工作流文件,并检查 README 字数是否少于 50 词。陌生人测试集成部分说明在接入后对 README 与文档运行 stranger-test-protocol,验证新人能否理解该仓库。
晋升就绪状态
资料列出状态与要求:LOCAL 需要 seed.yaml、README 与 .gitignore;CANDIDATE 需在此基础上增加 CI 通过、测试与 CLAUDE.md;PUBLIC_PROCESS 需增加陌生人测试通过和完整文档;GRADUATED 需增加生产使用与监控。
反模式
资料列举的反模式包括:没有 seed.yaml、跳过文档、手工搭建 CI、没有验证步骤、孤立的仓库、不加以适配地复制粘贴模板。
适用场景与限制
该技能适用于将新仓库纳入统一管理的生态系统、建立标准化 CI 与文档、按阶段推进仓库晋升,以及通过陌生人测试检验文档可理解性。资料未提供具体安装命令、收费信息、支持的平台或实际使用效果,模板内容为示例,需按实际仓库调整,不应直接照搬。