Skip to content

Commit 48c6fa9

Browse files
catlog22claude
andcommitted
docs: Update documentation for git staging and MCP recommendations
- Add pre-execution git staging to codex-execute workflow for clear change visibility - Update README to recommend MCP tools installation (not optional) - Add core principle: no unsolicited reports without user permission 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 3a78dac commit 48c6fa9

File tree

3 files changed

+27
-6
lines changed

3 files changed

+27
-6
lines changed

.claude/commands/cli/codex-execute.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Automated task decomposition and sequential execution with Codex, using `codex e
2424
```
2525
Task Input → Decompose into Subtasks → TodoWrite Tracking →
2626
For Each Subtask:
27+
0. Stage existing changes (git add -A) if valid git repo
2728
1. Execute with Codex
2829
2. [Optional] Git verification
2930
3. Mark complete in TodoWrite
@@ -61,6 +62,14 @@ For Each Subtask:
6162

6263
### Phase 2: Sequential Execution
6364

65+
**Pre-Execution Git Staging** (if valid git repository):
66+
```bash
67+
# Stage all current changes before codex execution
68+
# This makes codex changes clearly visible in git diff
69+
git add -A
70+
git status --short
71+
```
72+
6473
**For First Subtask**:
6574
```bash
6675
# Initial execution (no resume needed)
@@ -76,6 +85,9 @@ Subtask 1 of N: [subtask title]
7685

7786
**For Subsequent Subtasks** (using resume --last):
7887
```bash
88+
# Stage changes from previous subtask (if valid git repository)
89+
git add -A
90+
7991
# Resume previous session for context continuity
8092
codex exec "
8193
CONTINUE TO NEXT SUBTASK:
@@ -271,9 +283,10 @@ codex exec "CONTINUE TO NEXT SUBTASK: ..." resume --last --skip-git-repo-check -
271283
1. **Subtask Granularity**: Keep subtasks small and focused
272284
2. **Clear Boundaries**: Each subtask should have well-defined input/output
273285
3. **Git Hygiene**: Use `--verify-git` for critical refactoring
274-
4. **Context Continuity**: Let `codex resume --last` maintain context
275-
5. **Recovery Points**: TodoWrite provides clear progress tracking
276-
6. **Image References**: Attach design files for UI tasks
286+
4. **Pre-Execution Staging**: Stage changes before each subtask to clearly see codex modifications
287+
5. **Context Continuity**: Let `codex resume --last` maintain context
288+
6. **Recovery Points**: TodoWrite provides clear progress tracking
289+
7. **Image References**: Attach design files for UI tasks
277290

278291
## Input Processing
279292

CLAUDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ For all CLI tool usage, command syntax, and integration guidelines:
2828
- **Learning from existing code** - Study and plan before implementing
2929
- **Clear intent over clever code** - Be boring and obvious
3030
- **Follow existing code style** - Match import patterns, naming conventions, and formatting of existing codebase
31+
- **No unsolicited reports** - Task summaries can be performed internally, but NEVER generate additional reports, documentation files, or summary files without explicit user permission
3132

3233
### Simplicity Means
3334

@@ -56,6 +57,7 @@ For all CLI tool usage, command syntax, and integration guidelines:
5657

5758
**NEVER**:
5859
- Make assumptions - verify with existing code
60+
- Generate reports, summaries, or documentation files without explicit user request
5961

6062
**ALWAYS**:
6163
- Plan complex tasks thoroughly before implementation

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,9 +335,9 @@ Optimize performance by excluding unnecessary files:
335335
!**/CLAUDE.md
336336
```
337337

338-
### **Optional: MCP Tools** *(Enhanced Analysis)*
338+
### **Recommended: MCP Tools** *(Enhanced Analysis)*
339339

340-
MCP (Model Context Protocol) tools provide advanced codebase analysis. **Completely optional** - CCW works perfectly without them.
340+
MCP (Model Context Protocol) tools provide advanced codebase analysis. **Recommended installation** - While CCW has fallback mechanisms, not installing MCP tools may lead to unexpected behavior or degraded performance in some workflows.
341341

342342
#### Available MCP Servers
343343

@@ -350,7 +350,13 @@ MCP (Model Context Protocol) tools provide advanced codebase analysis. **Complet
350350
- 📊 **Faster Analysis**: Direct codebase indexing vs manual searching
351351
- 🌐 **External Context**: Real-world API patterns and examples
352352
- 🔍 **Advanced Search**: Pattern matching and similarity detection
353-
-**Automatic Fallback**: Uses traditional tools when MCP unavailable
353+
-**Better Reliability**: Primary tools for certain workflows
354+
355+
⚠️ **Note**: Some workflows expect MCP tools to be available. Without them, you may experience:
356+
- Slower code analysis and search operations
357+
- Reduced context quality in some scenarios
358+
- Fallback to less efficient traditional tools
359+
- Potential unexpected behavior in advanced workflows
354360

355361
---
356362

0 commit comments

Comments
 (0)