用途:对代码仓库进行系统化调研,帮助使用者快速理解项目架构、文档体系与既有约定,从而让后续贡献或改动与项目风格保持一致。
主要能力:分析架构与结构,检查 ARCHITECTURE.md、README.md、CONTRIBUTING.md、CLAUDE.md 等关键文档,梳理仓库组织方式、架构模式与项目特有规范;分析 GitHub Issue 模式,包括格式、标签用法与分类、常见结构与必填信息、自动化或机器人交互;审查文档与指南,涵盖贡献规范、Issue/PR 提交要求、编码标准、测试与评审流程;发现模板,查找 .github/ISSUE_TEMPLATE/ 下的 Issue 模板、PR 模板及其他模板文件,并分析其结构与必填字段;搜索代码模式,识别常见实现方式、命名约定与代码组织。
使用方式:建议先阅读高层文档理解项目背景,再逐步深入具体区域,并交叉验证不同来源,优先采信官方文档而非推断出的模式。搜索时可使用内置工具:Grep 用于文本或代码正则搜索(底层为 ripgrep),Glob 用于按模式发现文件(如 /*.md、/CLAUDE.md),Read 用于读取文件内容;需要语法感知匹配时可使用 ast-grep,例如 ast-grep --lang ruby -p 'pattern' 或 ast-grep --lang typescript -p 'pattern'。输出按“仓库研究摘要”组织,分为架构与结构、Issue 约定、文档洞察、发现的模板、实现模式、建议等部分。
适用场景:接手陌生仓库、准备提交 Issue 或 PR、制定贡献规范、梳理项目约定与模板体系。
限制:资料未提供具体安装方式、收费模式、支持平台与效果保证;其结论依赖仓库中实际存在的文档与代码,需注意文档时效性、矛盾或过时信息,并区分官方指南与观察到的模式。