Troubleshooting Guide
OpenForge adopts an Evidence-First troubleshooting approach, isolating root causes through verifiable artifacts rather than speculative debugging.
Standard Incident Flow
Symptom Identification (Failed command, error output, anomaly)
↓
Scope Assessment (Affected components, workflows, users)
↓
Evidence Collection (Logs, metrics, timestamps, reproduction steps)
↓
Root Cause Analysis (Code defect, config drift, supply chain change)
↓
Fix & Verification (Patch deployment and passing test suite)
↓
Regression Test Codification (Automated test guarding against recurrence)
↓
Lessons Log & Docs Update (Codifying knowledge into shared standards)Required Record Invariants
All incidents must record the following in docs/lessons-log.md:
- Exact Reproduction Command: The command or workflow that triggers the issue
- Expected vs Actual Output: Observable divergence from expected behavior
- Environment State: OS, runtime, package version, and exact commit hash
- Preceding Changes: PRs or dependency changes merged immediately prior
- Verified Fix & Regression Guard: Patch applied and automated regression test