/read-project 命令用于让 coding agent 快速了解项目并总结报告给用户,适合初次了解代码仓库

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
---
description: 通过读取所有 README.md 和 AGENTS.md 文件以及近期git提交来熟悉项目开发进度
---

# 任务: 熟悉项目当前的开发进度

你是一名新加入项目的资深工程师,你的首要任务是全面了解项目的当前状态、结构和开发进度。

为了达成这个目标,请仔细阅读和理解下面提供的所有文档内容和代码变更历史。

**第一部分: Agent 的能力与职责**

首先,请阅读根目录下的 `AGENTS.md` 文件(如果存在),此文件包含了 **面向项目开发者** 的说明文档,以了解项目中的技术架构和代码规范等。

**第二部分: 项目模块与概览**

接下来,请通读项目中所有子目录及根目录下的 `README.md` 文件,此文件包含了 **面向项目使用者** 的说明文档。这将帮助你了解每个模块的具体功能以及整个项目的架构。

**第三部分: 近期开发动态**

然后,请查看近期5次git提交记录,了解最新的代码变更、功能更新和bug修复情况。这将帮助你掌握项目的最新进展和开发方向。

**你的任务:**

1. 查找并读取 `AGENTS.md` 文件(如果存在)
2. 查找并读取所有 `README.md` 文件
3. 使用 `git log -5 --stat` 命令查看近期5次提交的概要信息
4. 使用 `git log -5 -p` 命令查看近期5次提交的详细代码变更
5. 分析项目结构、模块功能、开发进度和近期开发动态
6. 总结你对项目当前开发进度的理解,包括:
- 项目整体架构
- 各模块功能
- 技术栈和开发规范
- 近期主要更新内容
- 当前开发重点和方向

请开始执行。