Skip to content

Commit 76ff92b

Browse files
justin808claude
andcommitted
Add PR splitting strategy documentation for complex CI failures
Document comprehensive strategy for breaking large PRs into smaller, more manageable pieces when facing multiple CI test failures. New Document: .claude/docs/pr-splitting-strategy.md Key Sections: 1. When to Split a Large PR - Indicators: multiple failures, 50+ commits, mixed concerns - Decision criteria and time investment thresholds - Real example: PR #2069 with 52 commits, 3 failures + 1 hung 2. Strategy for Splitting - Identify independent commits - Determine merge order (docs → bug fixes → infrastructure) - Create focused PRs with clear scope - Handle original PR (close vs rebase) 3. Real-World Example: PR #2069 Split Plan - PR 1: Documentation (merge first, zero risk) - PR 2: buildConsoleReplay fix (focused bug fix) - PR 3: Workspace dependencies (small infrastructure) - PR 4: Monorepo node renderer (defer, most complex) 4. Benefits & Anti-Patterns - Benefits: easier review, incremental progress, better debugging - Anti-patterns: splitting too much, dependent changes, no testing - Decision tree for when to split 5. Templates & Timelines - PR split announcement template - Real-world 4-week timeline example - Incremental progress vs stuck on one PR Updated: .claude/docs/analysis/INDEX.md - Added pr-splitting-strategy.md as document #6 - Added to quick navigation: "Decide whether to split a large PR" - Listed in related documentation section Rationale: When facing complex PRs with multiple CI failures (like PR #2069): - 52 commits make bisecting difficult - Multiple unrelated failures (integration, Pro, hung tests) - Estimated 4-8 hours to fix all issues - Some parts can provide value independently Splitting allows: - Merge low-risk changes (docs) immediately - Review focused changes more easily - Incremental progress instead of being blocked - Better attribution if new issues arise - Unblock dependent work This strategy applies to any large PR with multiple failures, not just monorepo work. Provides decision framework and concrete examples. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 3c59f10 commit 76ff92b

File tree

2 files changed

+506
-0
lines changed

2 files changed

+506
-0
lines changed

.claude/docs/analysis/INDEX.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,46 @@ Suggested improvements for developer experience in monorepo context.
8383

8484
**Use when**: Reviewing documentation enhancement opportunities
8585

86+
### 6. pr-splitting-strategy.md (STRATEGIC - 12 KB)
87+
88+
**Strategy guide for breaking large PRs into smaller ones**
89+
90+
Contains:
91+
92+
- When to split a large PR (indicators and decision criteria)
93+
- Strategy for identifying independent commits
94+
- Step-by-step splitting process
95+
- Real-world example: How to split PR #2069
96+
- Benefits, anti-patterns, and decision tree
97+
- Template for announcing PR splits
98+
99+
**Use when**: Facing complex CI failures in large PRs, planning PR strategy, deciding whether to split
100+
101+
---
102+
103+
## Related Documentation
104+
105+
Outside the analysis directory:
106+
107+
- **PR Splitting Strategy**: `/.claude/docs/pr-splitting-strategy.md` (splitting large PRs)
108+
- **Main Migration Plan**: `/docs/MONOREPO_MERGER_PLAN.md` (authoritative source)
109+
- **Path Management Guide**: `/.claude/docs/managing-file-paths.md` (validation procedures)
110+
- **Build Script Testing**: `/.claude/docs/testing-build-scripts.md` (artifact verification)
111+
- **CI Monitoring**: `/.claude/docs/master-health-monitoring.md` (CI status checks)
112+
- **Contributing Guide**: `/CONTRIBUTING.md` (developer instructions)
113+
114+
---
115+
86116
## Quick Navigation
87117

88118
### I Need To...
89119

90120
**Fix current CI failures**
91121
→ Read: CI_FAILURES_2024-11-21.md (MOST URGENT)
92122

123+
**Decide whether to split a large PR**
124+
→ Read: pr-splitting-strategy.md (for complex PRs with multiple failures)
125+
93126
**Understand the current state**
94127
→ Read: Executive Summary in MONOREPO_MIGRATION_ANALYSIS.md
95128

0 commit comments

Comments
 (0)