Skip to content

Commit 7774fa0

Browse files
committed
docs(workflow): add dogfooding steps to The Drill
Add steps to use our own tools in the development workflow: 1. Find Next Work - Use 'dev gh search' to discover issues 2. Planning Phase - Use 'dev plan' to break down work This ensures we dogfood our own tools and catch bugs early. Benefits: - Tests tools in real scenarios - Identifies bugs (e.g., GitHub indexer persistence issue #36) - Validates usefulness for end users - Improves tool quality over time
1 parent 586355b commit 7774fa0

File tree

1 file changed

+40
-4
lines changed

1 file changed

+40
-4
lines changed

docs/WORKFLOW.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,62 @@ Standard workflow for implementing features in dev-agent.
44

55
## The Drill™
66

7-
### 1. Start New Feature
7+
### 1. Find Next Work (Dogfooding! 🐕🍽️)
88

99
```bash
1010
# Update main branch
1111
git checkout main
1212
git pull origin main
1313

14+
# Use GitHub Context to find what to work on next
15+
dev gh search "state:open label:\"Epic: MCP Integration\"" --type issue
16+
17+
# Or use gh CLI directly
18+
gh issue list --milestone "Epic #3: MCP Integration" --state open
19+
20+
# The tool helps you:
21+
# - Find open issues by epic/milestone
22+
# - See issue dependencies
23+
# - Prioritize based on labels
24+
# - Avoid duplicate work
25+
```
26+
27+
### 2. Start New Feature
28+
29+
```bash
1430
# Create feature branch (use feat/, fix/, docs/, etc.)
1531
git checkout -b feat/feature-name
1632

1733
# Update TODOs (mark as in_progress)
1834
# Done via todo_write tool in Claude
1935
```
2036

21-
### 2. Implementation Phase
37+
### 3. Planning Phase (Dogfooding! 🐕🍽️)
2238

2339
```bash
2440
# Read the issue requirements
2541
gh issue view <issue-number>
2642

43+
# Use the Planner to break down the work
44+
dev plan <issue-number> --json
45+
46+
# Review the plan and adjust as needed
47+
# The planner will:
48+
# - Break issue into specific tasks
49+
# - Find relevant code locations
50+
# - Estimate effort
51+
# - Suggest implementation order
52+
```
53+
54+
**Why dogfood the Planner?**
55+
- ✅ Tests our own tool in real scenarios
56+
- ✅ Identifies bugs and missing features
57+
- ✅ Improves estimation accuracy over time
58+
- ✅ Validates usefulness for end users
59+
60+
### 4. Implementation Phase
61+
62+
```bash
2763
# Design interfaces first (in comments or types)
2864
# Implement with test-driven development
2965
# Document with examples as you go
@@ -37,7 +73,7 @@ gh issue view <issue-number>
3773
- [ ] Create README if new module
3874
- [ ] Update related documentation
3975

40-
### 3. Quality Checks
76+
### 5. Quality Checks
4177

4278
```bash
4379
# Build all packages
@@ -65,7 +101,7 @@ pnpm typecheck
65101
- ✅ No TypeScript errors
66102
- ✅ Documentation with examples
67103

68-
### 4. Commit & PR
104+
### 6. Commit & PR
69105

70106
```bash
71107
# Stage all changes

0 commit comments

Comments
 (0)