repo-onboarding-cn

Use when first entering an unfamiliar repository and the user wants a concise Chinese architecture map, setup notes, and safe next steps before making changes.

SKILL.md

GitHub

Repo Onboarding CN

用于第一次接手陌生仓库、准备修 bug、做功能或评估项目质量之前。目标是快速建立可执行的项目地图,而不是写一篇泛泛的代码导览。

适用场景

  • 用户说“看一下这个项目”“这个仓库怎么跑”“先熟悉一下代码”。
  • 需要在动手前确认技术栈、入口、测试方式和风险区域。
  • 开源维护者需要把 issue 或改动分配给新贡献者。

不适用场景

  • 用户已经指定一个很小的文件级改动。
  • 只需要解释一段代码,不需要全仓库扫描。
  • 仓库含有敏感配置或私有数据时,不要把具体密钥、token、内部域名写进总结。

工作流

  1. 扫描根目录。
    • 优先读取 README*、AGENTS.md、CLAUDE.md、package.json、pyproject.toml、Cargo.toml、go.mod、docker-compose*、CI 配置。
    • 用 rg --files 查找主要入口、测试目录和配置文件。
  2. 建立项目地图。
    • 说明技术栈、主要模块、启动方式、测试方式、构建/部署线索。
    • 区分“确定事实”和“根据文件结构推断”。
  3. 找出协作入口。
    • 标出适合新贡献者阅读的文件。
    • 标出高风险区域:认证、支付、数据库迁移、任务队列、生产配置、安全边界。
  4. 给出下一步建议。
    • 如果用户要修 issue,建议先读哪些文件、跑哪些验证。
    • 如果仓库缺少文档,列出最小补文档清单。

输出格式

用中文输出,保持短而有用:

  • 项目一句话:这个仓库大概做什么。
  • 技术栈:语言、框架、包管理、数据库、部署线索。
  • 主要目录:列 5-8 个最重要目录。
  • 怎么运行/验证:基于已有脚本,不要编造。
  • 风险和空白:缺失文档、测试、配置或安全注意点。
  • 建议下一步:最多 3 条。

验证方式

  • 至少引用实际文件名支撑判断。
  • 如果没有运行测试或启动项目,明确说明“未运行”的原因。
  • 不要把猜测写成事实。