|
1 | 1 | description = "Summarize architecture, standards, and state to onboard a new developer." |
2 | 2 | prompt = """ |
3 | | -You are a senior software engineer responsible for onboarding a new developer to this project. |
4 | | -Your goal is to provide a clear, concise, and professional orientation that allows the newcomer to understand the codebase and start contributing effectively. |
| 3 | +You are a senior engineer onboarding a new developer. Provide a concise, high-signal orientation using direct observation. |
5 | 4 |
|
6 | | -**Step 1: Deep Analysis** |
7 | | -Use the `codebase_investigator` tool (or relevant search/read tools) to explore the following: |
8 | | -1. **Project Structure:** Identify the main directories (src, tests, docs, etc.) and their purposes. |
9 | | -2. **Core Architecture:** Determine the primary technologies, frameworks, and how the main components interact. |
10 | | -3. **Coding Standards & Practices:** Read files like `GEMINI.md`, `README.md`, `DESIGN.md`, and `makefile` or `pyproject.toml` to understand the development workflow (e.g., TDD, linting, dependency management). |
11 | | -4. **Current State & Recent History:** Read `CHANGELOG.md` and the latest entries in the `journal/` directory to understand what was recently implemented or fixed. |
12 | | -5. **Test Suite:** Briefly analyze how tests are structured and how to run them. |
| 5 | +**Phase 1: Direct Discovery** |
| 6 | +1. **Read Core Docs:** Read `README.md`, `GEMINI.md`, `TASKS.md`, and the 2 most recent entries in `journal/`. |
| 7 | +2. **Map Structure:** Use `list_directory` on the root and key directories (e.g., `src/`, `.gemini/`) to understand the layout. |
| 8 | +3. **Explore Context:** |
| 9 | + - If a `docs/` directory exists, read its contents to understand deeper project context. |
| 10 | + - If no `docs/` exists, identify and read 2-3 key source files (e.g., in `src/` or root) to understand implementation patterns. |
| 11 | +4. **Identify Entry Points:** Quickly scan the `makefile` (if it exists) to see common commands. |
13 | 12 |
|
14 | | -**Step 2: Generate the Onboarding Guide** |
15 | | -Produce a well-structured onboarding report with the following sections: |
16 | | -- **Project Overview:** A high-level summary of what the project does. |
17 | | -- **Architecture & Core Components:** Explain the "brain" of the project and how data flows. |
18 | | -- **Getting Started:** The essential commands to set up the environment, run tests, and start the application. |
19 | | -- **Coding Standards:** Key rules for documentation, testing (e.g., "We follow strict TDD"), and style. |
20 | | -- **Current Focus:** What the team has been working on lately (based on the journal/changelog). |
21 | | -- **Entry Points:** Point the developer to the most important files to read first. |
| 13 | +**Phase 2: Lean Onboarding Report** |
| 14 | +Produce a professional, welcoming summary: |
| 15 | +- **Project Purpose:** What this project does (from README). |
| 16 | +- **Architecture & Layout:** High-level mapping of directories and core technologies. |
| 17 | +- **Workflow & Standards:** How to run, test, and commit (from GEMINI.md/README/makefile). |
| 18 | +- **Deep Dive (if available):** Key insights from `docs/` or source code analysis. |
| 19 | +- **Current State:** Recent activity and active tasks (from journal/TASKS.md). |
| 20 | +- **First Steps:** 2-3 specific files or commands to start with. |
22 | 21 |
|
23 | | -Ensure your tone is welcoming and technically rigorous. |
24 | | -
|
25 | | -Wait for the user's explicit goal or additional questions if they provide any. Otherwise, suggest follow-up questions regarding deeper explorations of specifics of the codebase. |
| 22 | +Do not invoke sub-agents. Synthesize the report directly from your findings. |
26 | 23 | """ |
0 commit comments