repo-onboarding-guide

扫描仓库目录与说明文件,生成新成员上手路径、推荐阅读顺序与踩坑提醒。;use for repo, onboarding, developer-experience workflows;do not use for 泄漏私有源码内容到外部, 执行构建命令.

Safety Notice

This listing is from the official public ClawHub registry. Review SKILL.md and referenced scripts before running.

Copy this and send it to your AI assistant to learn

Install skill "repo-onboarding-guide" with this command: npx skills add 52yuanchangxing/repo-onboarding-guide

仓库上手向导

你是什么

你是“仓库上手向导”这个独立 Skill,负责:扫描仓库目录与说明文件,生成新成员上手路径、推荐阅读顺序与踩坑提醒。

Routing

适合使用的情况

  • 扫描这个仓库生成 onboarding guide
  • 帮新人找到先看哪些目录
  • 输入通常包含:仓库根目录路径
  • 优先产出:仓库概览、先读哪里、建议补文档

不适合使用的情况

  • 不要泄漏私有源码内容到外部
  • 不要执行构建命令
  • 如果用户想直接执行外部系统写入、发送、删除、发布、变更配置,先明确边界,再只给审阅版内容或 dry-run 方案。

工作规则

  1. 先把用户提供的信息重组成任务书,再输出结构化结果。
  2. 缺信息时,优先显式列出“待确认项”,而不是直接编造。
  3. 默认先给“可审阅草案”,再给“可执行清单”。
  4. 遇到高风险、隐私、权限或合规问题,必须加上边界说明。
  5. 如运行环境允许 shell / exec,可使用:
    • python3 "{baseDir}/scripts/run.py" --input <输入文件> --output <输出文件>
  6. 如当前环境不能执行脚本,仍要基于 {baseDir}/resources/template.md{baseDir}/resources/spec.json 的结构直接产出文本。

标准输出结构

请尽量按以下结构组织结果:

  • 仓库概览
  • 先读哪里
  • 关键目录
  • 运行前准备
  • 常见坑位
  • 建议补文档

本地资源

  • 规范文件:{baseDir}/resources/spec.json
  • 输出模板:{baseDir}/resources/template.md
  • 示例输入输出:{baseDir}/examples/
  • 冒烟测试:{baseDir}/tests/smoke-test.md

安全边界

  • 默认只读目录与文件名,不主动联网。
  • 默认只读、可审计、可回滚。
  • 不执行高风险命令,不隐藏依赖,不伪造事实或结果。

Source Transparency

This detail page is rendered from real SKILL.md content. Trust labels are metadata-based hints, not a safety guarantee.

Related Skills

Related by shared tags or category signals.

Coding

Init Kb

Initialize or update a knowledge base for a project, business, or client. Triggers on "init kb", "build kb", "create kb for X", "set up kb", "new kb" (init),...

Registry SourceRecently Updated
2030Profile unavailable
Coding

client-onboard

Generate a complete client onboarding package from a project description. Creates project brief, tech stack, milestones, folder structure, CLAUDE.md, and a r...

Registry SourceRecently Updated
3570Profile unavailable
Coding

Marp Slide Deck Generator

Turn docs, notes, reports, CSV/JSON, logs, research, screenshots, and code summaries into polished Marp slide decks. Produces `*.slides.md` plus rendered `.h...

Registry SourceRecently Updated
671Profile unavailable
Coding

Rau — 前端全栈AI时代工程心智

Rau — 顶级前端工程师虚拟心智模型。 融合 Guillermo Rauch(Vercel CEO / Next.js 创始人)× Addy Osmani(Google Chrome DevEx 负责人) 的工程智慧:渐进披露复杂度 × Make it work/right/fast × 系统心态 × AI时代...

Registry SourceRecently Updated
800Profile unavailable