Skip to content
cccskills
FreePublished on GitHub

github-code-interpreter

GitHub 源码解读助手。适用于用户提供 GitHub 仓库链接,并希望解读源码、理解原理、分析架构、生成学习报告或快速上手文档时使用。会在 working 目录下生成源码解读和快速上手两份文档。

默认先交付初稿,不自动复查;如果用户明确同意,再安排后续复查。不适用于仅克隆仓库或只要一句简介的场景。

The English summary is being prepared. Showing the original description.

Works withGitHub
See how to install

Files included (4)

  • SKILL.md5.2 KB
  • references/report-outline.md5.7 KB
  • scripts/bootstrap_github_analysis.py8.3 KB
  • scripts/review.sh3.2 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

GitHub 源码解读助手

设计模式

本 skill 主要采用:

  • Pipeline:按“定位仓库 → 建目录 → 阅读分析 → 生成两份文档 → 交付 → 如有需要再复查”的顺序执行
  • Generator:稳定产出源码解读与快速上手两份文档
  • Inversion(轻度):开始前先确认分析范围,复查前再次征求用户同意

Gotchas

  • 不要把“只想克隆仓库”误判成“源码解读”
  • 不要假装已经全读完大型仓库;必须说明本次聚焦模块
  • 不要默认安排复查;是否复查必须先征求用户确认
  • 不要凭空编造运行命令、依赖关系、架构细节
  • 如果当前渠道支持发文件,应优先发文件,不要只丢路径

适用边界

使用本 skill:

  • 用户提供 GitHub 仓库链接,并明确要“解读源码 / 分析架构 / 理解原理 / 生成学习报告 / 快速上手”
  • 用户想把一个开源项目梳理成可读的中文文档

不要使用本 skill:

  • 用户只想克隆仓库
  • 用户只想要一句简介或推荐语
  • 用户要解读论文或普通技术文章

核心交付

在合适的 ~/Documents/working 子目录下创建项目分析目录,并产出两份文档:

  • <repo_name>_源码解读.md
  • <repo_name>_快速上手.md

可额外产出:

  • structure.txt
  • metadata.json

报告结构参考 references/report-outline.md。

工作流

0. 先确认分析范围(必须先做)

开始前先向用户确认或声明本次分析范围,至少覆盖:

  • 是否只做架构解读,还是同时生成快速上手文档
  • 是否聚焦某个模块,还是做整体源码导读
  • 最终交付以本地文档为主,而不是在对话中直接长篇展开

如果用户已经明确说了“解读源码/分析架构/生成报告”,可直接进入执行,并在回复里顺手说明本次范围。

1. 确定工作目录

按以下优先级选择输出目录:

  1. 用户明确指定的目录
  2. 当前上下文里已存在且明显合适的 ~/Documents/working 子目录
  3. 默认使用 ~/Documents/working/github-analysis/<repo_name>

不要跳出 ~/Documents/working 体系。

2. 定位仓库

优先在 ~/Documents/coding/github 中查找目标仓库。

  • 已存在:直接使用
  • 不存在:克隆到 ~/Documents/coding/github/<repo_name>

3. 初始化分析目录

需要快速完成仓库定位、结构导出、元数据生成时,运行:

python3 scripts/bootstrap_github_analysis.py <github_url> ~/Documents/working

如果脚本不可用,就手动完成以下事情:

  • 创建分析目录
  • 导出目录结构
  • 记录仓库路径、分支、最后提交时间等基础信息

4. 阅读与分析

至少覆盖这些内容:

  • README.md 和核心文档
  • 依赖或构建文件,如 package.json、pyproject.toml、Cargo.toml
  • 主要源码目录
  • 测试、示例、文档目录

大型仓库不要假装“全读完了”。要明确说明本次聚焦的模块或子系统。

5. 生成两份文档

源码解读文档

至少包括:

  • 项目是做什么的
  • 适用场景
  • 优点与局限
  • 整体架构与关键模块
  • 核心原理 / 关键数据流 / 关键算法
  • 设计思想与值得借鉴的点
  • 必要术语解释
  • 按需调用 mermaid skill 生成图

快速上手文档

至少包括:

  • 环境要求
  • 安装步骤
  • 配置说明
  • 最小可运行示例
  • 常见问题
  • 下一步建议先读哪些源码

6. 交付要求

完成初稿后,先把两份文档路径明确告诉用户,再补充:

  • 仓库本地路径
  • 输出目录路径
  • 本次分析范围
  • 还没验证的部分

如果当前渠道支持发文件,就直接发送文件;如果不支持,就至少给出可点击路径。

7. 复查原则

默认不自动复查。

如果你判断这份分析值得继续完善,只能先问用户要不要复查;用户明确同意后,才可以安排约 1 小时后的复查。 如果当前环境不方便安排,就不要假装已经安排成功,直接告诉用户即可。

复查时遵循增量更新:

  • 先读现有两份文档
  • 再看仓库是否有更新
  • 补充遗漏架构细节、使用场景、设计思想
  • 必要时验证快速上手文档
  • 在文档末尾追加复查记录

输出要求

汇报时至少包含:

  • 仓库名与本地路径
  • 输出目录
  • 两份文档路径
  • 本次聚焦模块
  • 是否建议复查,以及如需复查必须先征求用户确认

注意事项

  • 大型仓库优先聚焦核心模块,不要泛泛而谈
  • 先看文档,再读源码,避免误解设计意图
  • 快速上手文档尽量基于真实命令,不要凭空猜
  • 不要把“当前渠道的文件发送格式”写死成某个平台专用语法

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

为照片、身份证、护照、学位证、毕业证、资格证、营业执照等证件或证书扫描件及 PDF 添加本地文字水印。用户提出照片加版权水印、身份证或学历证件添加“仅限某用途”水印、资质文件批量加水印、生成水印预览,或需要保持头像、二维码、印章等区域可辨认时使用。支持 JPEG、PNG、WebP 和 PDF,默认先预览、保留原件并清除图片元数据。不用于去除水印、伪造或篡改证件内容,也不用于仅设计 Logo 水印素材。

The English summary is being prepared. Showing the original description.

chujianyun/skills748Updated Oct 16, 2026

AGENTS.md / CLAUDE.md 最佳实践顾问。用于用户询问 agents markdown、AGENTS.md、CLAUDE.md、Claude Code memory、AI coding agent 指令文件的格式、结构、最佳实践;也用于审查、诊断、重写、优化或从零创建 AGENTS.md、CLAUDE.md、CLAUDE.local.md、.claude/rules 等 agent 指令文件。不适用于通用 README 写作,除非目标是给 AI coding agent 提供项目上下文。

The English summary is being prepared. Showing the original description.

chujianyun/skills748Updated Oct 16, 2026

Agent 设计顾问与审查工具。基于 12-Factor AgentOps 最佳实践,用于:(1) 探讨 Agent 架构设计方案;(2) 审查现有 Agent/Skill/工作流的设计,发现问题,给出改进建议。触发词:审查我的 agent、帮我分析这个 skill、agent 设计、agent 优化、帮我 review 这个工作流、这个 agent 有什么问题、怎么设计 agent、agent 架构咨询。

The English summary is being prepared. Showing the original description.

chujianyun/skills748Updated Oct 16, 2026

喔图(alltuu.com)云摄影相册批量下载工具。当用户需要从 alltuu.com / m.alltuu.com 相册批量下载原图时使用此技能。支持下载原图(6720x4480 级别),自动处理签名URL,并发下载。适用于 alltuu.com/album/ 相册链接。

The English summary is being prepared. Showing the original description.

chujianyun/skills748Updated Oct 16, 2026

文章解读助手。对用户提供的文章(URL、Markdown、PDF、粘贴文本)进行结构化解读,输出包含总览、关键要点、个人启发、批判性思考和延伸思考的 Markdown 报告。触发词:文章解读、解读文章、帮我解读、读一下这篇、分析这篇文章、article interpretation。

The English summary is being prepared. Showing the original description.

chujianyun/skills748Updated Oct 16, 2026

baize

Free

将公开或用户有权访问的 Wiki 完整转换为面向 Agent 的离线知识 Skill,并按原 Wiki 层级保存 Markdown、生成检索索引和逐文档哈希清单,支持无变化不落盘的手动或自动增量更新。当用户要求把 Wiki、文档站或帮助中心做成 Skill、同步已有 Wiki Skill、保持文档目录树或设置 Wiki Skill 自动更新时使用;不用于只摘要单篇网页或绕过登录、付费墙和访问控制。

The English summary is being prepared. Showing the original description.

chujianyun/skills748Updated Oct 16, 2026

See all skills by chujianyun

Report a problem with this skill