Skip to content

Commit 9e58c45

Browse files
committed
docs(readme): reorganize into project lifecycle and document /plan
1 parent 8373c8a commit 9e58c45

2 files changed

Lines changed: 39 additions & 30 deletions

File tree

README.md

Lines changed: 38 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,48 +23,56 @@ In this framework, the AI agent is not just a "code generator" or a "copilot". I
2323
* **📋 Research -> Plan -> Execute:** Every non-trivial change follows a strict lifecycle. The agent first researches context, proposes a detailed plan, waits for your explicit approval, and only then begins implementation.
2424
* **✅ Validation-Always:** The framework uses `make` as a source of truth. The agent is hooked into the `makefile` to ensure every change is validated (linted and tested) before being finalized.
2525

26-
## 🛠️ Powerful Commands
26+
---
27+
28+
## 🛠️ The Project Lifecycle
2729

28-
The `.gemini/commands/` directory defines specialized workflows that automate the entire development lifecycle:
30+
The `.gemini/commands/` directory defines specialized workflows that automate every phase of the development lifecycle:
2931

30-
### 📁 Project Management & Discovery
31-
* **`/plan`**: An interactive planning workflow that gathers context, analyzes the codebase, and generates a detailed execution plan saved in `plans/`. It also synchronizes with your `TASKS.md` and issues.
32+
### 🔍 Phase 1: Planning & Discovery
33+
* **`/research <topic>`**: A deep, 3-phase investigation (Planning -> Data Gathering -> Reporting) that produces exhaustive Markdown reports in the `research/` directory. **Crucial for gathering technical requirements and state-of-the-art context.**
34+
* **`/plan`**: The **Architectural Bridge**. This interactive workflow translates ideas into actionable execution plans:
35+
* **Phase 1 (Clarification):** The agent interviews you to resolve ambiguities before planning.
36+
* **Phase 2 (Agentic Analysis):** A specialized `planner` subagent scans the codebase and generates a detailed technical strategy.
37+
* **Phase 3 (Artifact Generation):** A persistent Markdown plan is saved in `plans/` (e.g., `plans/feature-x.md`).
38+
* **Phase 4 (Synchronization):** The plan is optionally linked to `TASKS.md` and can be synchronized with GitHub issues.
3239
* **`/onboard`**: Summarizes the project's architecture, standards, and current state to quickly orient a new developer (or the agent itself).
40+
41+
### 🏗️ Phase 2: Development & Execution
42+
* **`/issues`**: Your gateway to GitHub integration. It allows you to list, create, or update issues. Use `/issues work <number>` to transition an issue directly into a detailed research and planning mode.
3343
* **`/task`**: Manages the project roadmap in `TASKS.md`. Use it to `create` new tasks, `work` on existing ones (marks as In Progress), `report` on priorities, or `update` the roadmap.
34-
* **`/issues`**: Integrates with the GitHub CLI (`gh`) to list, create, or update issues. It can transition from an issue directly into an implementation **Plan**.
44+
* **`/scaffold`**: Initializes new project structures from scratch using modern, standard tooling (Python/uv, TS/npm, Rust/cargo, etc.) and sets up a compatible `makefile`.
3545

36-
### 🏗️ Development & Maintenance
37-
* **`/scaffold`**: Initializes a new project from scratch using modern, standard tooling (Python/uv, TS/npm, Rust/cargo, etc.) and sets up a compatible `makefile`.
38-
* **`/research <topic>`**: A deep, 3-phase investigation workflow (Planning -> Data Gathering -> Reporting) that produces exhaustive Markdown reports in the `research/` directory.
39-
* **`/maintenance`**: Performs a deep scan of the codebase to identify refactoring opportunities, improve documentation, and increase test coverage.
46+
### 🧹 Phase 3: Maintenance & Documentation
47+
* **`/maintenance`**: Performs a deep scan of the codebase to identify technical debt, refactoring opportunities, and areas to improve test coverage.
4048
* **`/docs`**: Analyzes the codebase and journals to generate or update comprehensive project documentation in the `docs/` folder.
41-
* **`/cron`**: Manages repetitive background tasks (e.g., daily reports, health checks) using **systemd user timers**.
49+
* **`/cron`**: Manages repetitive background tasks (e.g., health checks, automated reports) using **systemd user timers**.
4250

43-
### 🚀 Shipping & Quality
44-
* **`/commit`**: Analyzes changes, groups them into logical features or fixes, and guides you through committing them individually using **Conventional Commits**.
51+
### 🚀 Phase 4: Shipping & Quality
52+
* **`/commit`**: Analyzes all uncommitted changes, groups them into logical features or fixes, and guides you through committing them individually using **Conventional Commits**.
4553
* **`/release`**: Automates the final shipping steps: running tests, determining the next version (semver), updating the `CHANGELOG.md`, and tagging the release.
4654

47-
## 🔄 Common Workflows
55+
---
56+
57+
## 🔄 Standard Operating Procedures (SOPs)
4858

4959
This framework shines when you combine these commands into cohesive workflows:
5060

51-
### 1️⃣ Feature Lifecycle: From Idea to Ship
52-
1. **Discovery:** `/research "best way to implement X"`
53-
2. **Planning:** `/task create "Implement X based on research"`
54-
3. **Implementation:** `/task work "Implement X"`
55-
4. **Refining:** `/docs` to ensure documentation is up-to-date.
56-
5. **Committing:** `/commit` to logically group and commit changes.
57-
6. **Releasing:** `/release` to bump the version and tag the code.
58-
59-
### 2️⃣ Routine Maintenance & Health
60-
1. **Investigation:** `/maintenance` to identify technical debt.
61-
2. **Automation:** `/cron "daily maintenance"` to run linting or small refactorings during off-hours.
62-
3. **Reporting:** `/task report` to see pending roadmap items.
63-
64-
### 3️⃣ Collaboration & Issue Tracking
65-
1. **Triage:** `/issues summary` to see what needs attention.
66-
2. **Deep Dive:** `/issues work 42` to research issue #42 and propose a fix.
67-
3. **Onboarding:** New collaborators run `/onboard` to get up to speed in seconds.
61+
### 1️⃣ Feature Development Workflow
62+
1. **Discover:** Run `/research` to understand the domain or library.
63+
2. **Plan:** Use `/plan` to turn requirements into a technical roadmap in `plans/`.
64+
3. **Track:** Link the plan to `TASKS.md` using `/plan`'s built-in sync.
65+
4. **Implement:** Use `/task work` to mark progress and begin coding.
66+
5. **Refine:** Run `/docs` to ensure your changes are well-documented.
67+
6. **Ship:** Use `/commit` for clean history and `/release` for a new version tag.
68+
69+
### 2️⃣ Bug Resolution Workflow
70+
1. **Triage:** Use `/issues summary` to see what needs attention.
71+
2. **Reproduce:** Use `/issues work <id>` to research the root cause.
72+
3. **Fix:** Develop the fix and validate with `make`.
73+
4. **Sync:** Update the issue with the resolution details.
74+
75+
---
6876

6977
## ⚓ The Hook System: Staying in Sync
7078

journal/2026-03-02.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
- Restored and updated `CHANGELOG.md` for the v0.7.0 release.
55
- Implemented a custom `/plan` command workflow and a `planner` sub-agent to generate execution plans in `plans/` and synchronize with `TASKS.md`.
66
- Initiated the planning process for drafting and editing capabilities, including the design of `/draft` and `/revise` commands and subagent integration.
7+
- Reorganized `README.md` to reflect a structured project lifecycle (Planning, Development, Maintenance, Shipping) and documented the `/plan` command's interactive phases.

0 commit comments

Comments
 (0)