用于快速理解新代码库或新项目的结构和工作方式的技能。包含项目结构分析、关键文件识别、配置信息收集、依赖关系梳理。适用于新项目接手、代码审查前的背景了解、大型项目导航等场景。
项目上下文加载:快速理解代码库结构的技能
【适用场景】
Step 1:新项目接手
当你需要接手一个新项目时,快速了解项目结构和技术栈。Step 2:代码审查准备
在进行代码审查前,先加载项目上下文,理解整体架构。Step 3:大型项目导航
当在大型代码库中工作时,快速定位相关文件和模块。Step 4:问题诊断背景收集
当需要诊断问题时,先了解项目上下文帮助定位问题。【操作步骤】
第一步:项目结构扫描 查看根目录文件结构,识别项目类型(前端/后端/全栈)。
第二步:配置文件识别 找到并阅读关键配置文件:package.json、requirements.txt、pom.xml等。
第三步:入口文件分析 识别项目入口文件:main.py、App.js、index.ts等。
第四步:依赖关系梳理 理解模块间依赖关系和调用链。
【代码模板】
项目结构扫描 ```bash
查看根目录结构
ls -la查看目录树
find . -maxdepth 2 -type d识别配置文件
ls .json .yaml *.toml 2>/dev/null ```关键文件清单 - 依赖配置:package.json/requirements.txt/pom.xml - 入口文件:main.py/App.js/index.ts - 框架配置:app.py/app.config.js - 环境配置:.env/.env.example
【复盘要点】
理解深度:根据任务需要决定理解深度,不需要一次性了解全部细节。
持续更新:随着工作深入持续更新对项目的理解。
文档优先:优先阅读README和文档,它们往往包含最重要的架构信息。
来源:GitHub https://github.com/mofan212/codex-profile/blob/master/profile/skills/load-project-context/SKILL.md