360 Secure SkillHub
360 安全技能中心

Repo Onboarding Guide

扫描仓库目录与说明文件,按仓库概览、先读哪里、关键目录、运行前准备、常见坑位、建议补文档等结构生成新成员上手向导;默认只读且不主动联网,不执行构建命令,缺信息时列出待确认项,可选本地 Python 脚本产出结果。

52yuanchangxing
52yuanchangxing
热度 76.32
最近更新 2026-05-11 17:35:27
分类:知识依赖:代码执行 / 读写文件应用场景:研究 / 摘要总结 / 笔记整理

安装技能

复制下面的话术发给你的 Agent,它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill: npx secure-skills-cli add repo-onboarding-guide
Metadata
name
repo-onboarding-guide
version
1.0.0
description
扫描仓库目录与说明文件,生成新成员上手路径、推荐阅读顺序与踩坑提醒。;use for repo, onboarding, developer-experience workflows;do not use for 泄漏私有源码内容到外部, 执行构建命令.
author
OpenClaw Skill Bundle
homepage
https://example.invalid/skills/repo-onboarding-guide
tags
["repo","onboarding","developer-experience","docs"]
user-invocable
true
metadata
{"openclaw":{"emoji":"🧬","requires":{"bins":["python3"]},"os":["darwin","linux","win32"]}}

仓库上手向导

你是什么

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

安全边界

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