用途:Professional Repo Docs 面向需要新建、整理或开源化 GitHub 仓库的场景。当用户希望“加 README/许可证/贡献指南”“补齐社区健康文件”“让仓库看起来更专业”“添加 issue/PR 模板”“接入 Sponsor”“添加 AGENTS.md”时触发,即使用户未逐项列出文件。
主要能力:该技能将项目文件夹转换为“agent-first”的专业仓库文档集合。它编码了一套约定,避免重复推导,并确保不重新生成对内容过滤敏感的规范文本:LICENSE 与 CODE_OF_CONDUCT.md 直接复制自带 assets/ 中的文件,不手写或改写。生成内容包括:README(lite 或 full)、LICENSE、.github/FUNDING.yml、CODE_OF_CONDUCT.md、CONTRIBUTING.md、SECURITY.md、SUPPORT.md、GOVERNANCE.md、CHANGELOG.md、可选 CITATION.cff、.github/ISSUE_TEMPLATE/*、.github/PULL_REQUEST_TEMPLATE.md、AGENTS.md、可选 llms.txt、品牌 logo。README 顶部有面向人类的提示,建议让 AI 代理阅读;底部带品牌块。脚本会检测 git owner/repo/branch、技术栈(npm/pip/go/cargo/flutter/static)以生成真实构建命令,并检测项目名与描述。
使用方式:进入目标仓库后运行 Node 脚本,例如:
node <skill-dir>/scripts/scaffold.mjs --readme lite --license MIT
常用参数:--dir <path>、--readme full|lite|none、--license <SPDX>、--name/--owner/--repo/--branch/--description、--citation、--no-llms、--no-agents、--force。无参数时默认 lite README、MIT、启用 llms 与 agents。交互流程为:检测上下文;根据项目类型建议许可证并与用户确认;选择 README 深度(lite 为精简版,full 为含徽章、目录、Mermaid 架构图等完整模板);运行脚手架;填写生成文件中的占位符与提示;打印两个非文件步骤(启用 Discussions 的 gh api 命令、在设置中开启 Sponsorships 开关);最后汇总创建与保留的文件,不提交不推送,若用户要求提交则使用 Conventional Commits。
适用场景:新项目初始化、已有仓库文档专业化、开源准备、社区健康文件补齐、接入赞助、为 AI 代理准备仓库说明。
限制与注意事项:只创建缺失文件,默认不覆盖已有文档;仅 .github/FUNDING.yml 会始终重写。不要重新生成许可证或行为准则,必须从 assets/ 复制。FUNDING.yml 不足以显示 Sponsor 按钮,还需在仓库设置中开启 “Sponsorships” 开关(无 API)。生成后应尽量填写占位符,不要留下原始脚手架。具体要求与细节可参考附带的 license-selection.md、readme-guide.md、agent-first-spec.md、doc-catalog.md、post-setup.md。