repo-overview

Files (1)

• SKILL.md

SKILL.md (first lines)

# 代码仓库速览

为刚接触仓库的人写一份 5 分钟能读完、每条都能核对的速览。只读，不改代码，不运行命令。

## 范围

- 当前工作区即仓库根目录。不读取工作区之外的路径，不联网，不执行安装或构建。
- 不读取 `.env`、密钥、证书等敏感文件；遇到时只说明“存在配置文件”。

## 工作流

1. `file_list` 看顶层结构；`file_find` 找清单文件：`package.json`、`pnpm-workspace.yaml`、`pyproject.toml`、`go.mod`、`Cargo.toml`、`pom.xml`、`Makefile`、`Dockerfile`。
2. 读取 README、贡献指南和清单文件，提取语言、框架、包管理器、脚本命令。
3. 找入口：`main`/`bin` 字段、`src/index.*`、`cmd/`、`app/` 等；用 `file_search` 追踪关键导出和路由。
4. 查看测试目录和 CI 配置（只读），记录测试命令与覆盖的范围。
5. 挑选 3–5 个核心模块，每个用一两句话说明职责并给出文件路径。
6. 对没读到或无法确认的内容标注「未确认」。

## 输出格式

```markdown
# <仓库名> 速览

## 一句话介绍
## 技术栈
## 目录结构（只列关键目录）
## 如何运行 / 构建 / 测试（命令来自 package.json 等，未执行验证）
## 核心模块
- `路径`：职责
## 上手建议（从哪里读起、常见坑）
## 未确认事项
```

## 完成标准

- 每条命令和路径都来自实际读取的文件。
- 明确说明命令未经执行验证。
- 没有读取或输出任何密钥内容。

From gmnoah/DeskForge, MIT.

More from gmnoah/DeskForge