repo-onboarding-guide

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

3,891 stars

Best use case

repo-onboarding-guide is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

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

Teams using repo-onboarding-guide should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/repo-onboarding-guide/SKILL.md --create-dirs "https://raw.githubusercontent.com/openclaw/skills/main/skills/52yuanchangxing/repo-onboarding-guide/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/repo-onboarding-guide/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How repo-onboarding-guide Compares

Feature / Agentrepo-onboarding-guideStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

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

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

# 仓库上手向导

## 你是什么
你是“仓库上手向导”这个独立 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`

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

Related Skills

Customer Onboarding

3891
from openclaw/skills

Systematically onboard new clients with checklists, welcome sequences, milestone tracking, and success metrics. Reduce churn by nailing the first 90 days.

Workflow & Productivity

Git Engineering & Repository Strategy

3891
from openclaw/skills

You are a Git Engineering expert. You help teams design branching strategies, implement code review workflows, manage monorepos, automate releases, and maintain healthy repository practices at scale.

DevOps & Infrastructure

ESG & Sustainability Reporting Framework

3891
from openclaw/skills

You are an ESG reporting specialist. Generate comprehensive Environmental, Social, and Governance reports aligned with 2026 disclosure standards.

Workflow & Productivity

Employee Onboarding Generator

3891
from openclaw/skills

Build a structured 90-day onboarding plan for any role. Covers pre-boarding, Day 1, Week 1, 30/60/90-day milestones, buddy assignments, and success metrics.

Workflow & Productivity

Board Reporting Framework

3891
from openclaw/skills

Generate investor-ready board decks and reporting packages. Covers monthly board updates, quarterly deep dives, and annual reviews with the metrics that actually matter.

Workflow & Productivity

Annual Report Generator

3891
from openclaw/skills

Build a complete annual business report from raw data. Covers financial performance, operational metrics, strategic highlights, and forward-looking guidance.

Workflow & Productivity

daily-report-generator

3891
from openclaw/skills

Automatically generate daily/weekly work reports from git commits, calendar events, and task lists. Use when you need to quickly create professional work reports without manual effort.

Workflow & Productivity

china-relocation-guide

3891
from openclaw/skills

Use when expats, international students, or digital nomads need guidance on relocating to China, choosing cities, understanding visa requirements, or planning their move.

Relocation Guides

kep-guide

3891
from openclaw/skills

Türkiye Kayıtlı Elektronik Posta (KEP) rehberi. KEP nedir, nasıl alınır, zorunlu mu, hangi kurumlar kullanıyor, entegrasyon yöntemleri. Use when asked about KEP, registered electronic mail, Türkkep, or Turkish official electronic communication.

PsyClaw Onboarding

3891
from openclaw/skills

你现在的唯一目标是完成 PsyClaw 入驻主线。

QuackExchange — Developer Guide

3891
from openclaw/skills

QuackExchange is a Q&A platform for AI agents and humans.

web3-weekly-report

3891
from openclaw/skills

自动抓取数据并生成 Web3 行业资本运作周报,涵盖融资事件、监管动态、上市公司 DAT 动态、并购交易与 RWA 项目追踪。当用户提到"写周报"、"生成周报"、"整理本周融资"、"Web3 周报"、"资本运作周报"、"采编周报",或请求整理加密行业本周动态时,立即激活此 skill。即使用户只说"帮我写本周的",只要上下文涉及 Web3、加密、融资、RWA、DAT,也应激活。