Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

reading-code-quickly

一个用于快速理解指定代码的 Agent Skill。

它不会把一次代码阅读扩展成完整的架构分析,而是围绕用户指定的代码,说明它在做什么、主流程如何运行、直接调用了哪些项目内部能力,以及它位于项目流程中的什么位置。

适合解决什么问题

  • 快速读懂一个代码片段、函数、类或文件;
  • 减少手动跳转到其他文件查找函数定义的成本;
  • 补充直接调用的参数、返回值和定义位置;
  • 在不深入整个代码库的前提下,建立局部项目认知。

它不用于 Bug 调试、代码审查、重构建议、逐行教学或深入架构分析。

核心特点

  • 主体明确:只围绕用户指定的代码讲解。
  • 只追踪一层:读取直接被调用者的定义,但不继续递归展开。
  • 补充调用契约:给出关键参数、返回值和证据强度。
  • 说明项目位置:向上查找一层调用者、路由、命令入口或注册位置。
  • 拒绝猜测:无法从源码确认的信息会明确标记为未知。

输出结构

Skill 固定按以下顺序输出,便于快速扫描:

  1. 一句话用途
  2. 主流程
  3. 外部调用表
  4. 项目位置
  5. 阅读结论

安装

将仓库克隆到 Agent Skills 目录:

git clone https://github.com/waitmeya/reading-code-quickly.git ~/.agents/skills/reading-code-quickly

如果运行环境使用独立的 Skill 目录,也可以将整个仓库复制到对应目录中。仓库根目录的 SKILL.md 是 Skill 入口。

使用示例

显式调用:

使用 $reading-code-quickly 快速讲解 src/services/order.py 中的 create_order,补充它直接调用的项目函数以及项目位置。

也可以直接提出符合触发条件的请求:

请快速讲解 app/routes.py 中的 profile_endpoint,让我知道它在做什么、主流程、直接依赖和项目位置。

典型输出形态:

## 一句话用途
...

## 主流程
1. ... — `file.py:line`

## 外部调用
| 调用 | 来源 | 作用 | 关键参数 | 返回值 |
|---|---|---|---|---|

## 项目位置
...

## 阅读结论
- ...

分析边界

向下分析时,Skill 只追踪项目内部的直接调用;向上定位时,只查找一层直接调用者或注册入口。标准库、日志、简单访问器和显然的格式转换通常不会单独展开。

参数、返回值和项目位置会区分三种证据强度:

  • 明确声明:来自签名、类型标注、可靠文档字符串或直接引用位置;
  • 根据实现推断:源码能够支持,但没有明确声明;
  • 无法确认:动态调用、运行时注入、定义缺失或存在歧义。

评估

evals/evals.json 提供了三类 Python 场景:

  • 普通函数调用项目工具函数;
  • handler 调用 service,并验证不会深入第二层 repository;
  • Web 路由与注册入口定位。

对应的最小代码样例位于 evals/fixtures/。评估重点包括输出结构、事实准确性、一层追踪边界、未知信息标记和阅读效率。

项目结构

.
├── SKILL.md
├── agents/
│   └── openai.yaml
├── evals/
│   ├── evals.json
│   └── fixtures/
├── LICENSE
└── README.md

贡献

欢迎提交 Issue 或 Pull Request。改动应继续服务于“快速理解指定代码”这一目标,并避免把 Skill 扩展成调试、审查或完整代码库分析工具。

License

MIT

About

快速理解指定代码、直接依赖和项目位置的 Agent Skill

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages