Skip to content

Commit 34665bb

Browse files
committed
docs: add cleanup command to README
- Add step 7 for cleanup in quick start guide - Add cleanup to core commands table - Add detailed step 8 in walkthrough section explaining: - Small/medium/large issue handling - Output artifacts (fixes, tasks, tech-debt-report.md) - Critical issue halt behavior
1 parent eace261 commit 34665bb

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,14 @@ Use **`/speckit.implement`** to execute all tasks and build your feature accordi
132132
/speckit.implement
133133
```
134134

135+
### 7. Review and clean up
136+
137+
Use **`/speckit.cleanup`** to review all implementation changes, identify tech debt, and ensure code quality.
138+
139+
```bash
140+
/speckit.cleanup
141+
```
142+
135143
For detailed step-by-step instructions, see our [comprehensive guide](./spec-driven.md).
136144

137145
## 📽️ Video Overview
@@ -258,6 +266,7 @@ Essential commands for the Spec-Driven Development workflow:
258266
| `/speckit.plan` | Create technical implementation plans with your chosen tech stack |
259267
| `/speckit.tasks` | Generate actionable task lists for implementation |
260268
| `/speckit.implement` | Execute all tasks to build the feature according to the plan |
269+
| `/speckit.cleanup` | Review implementation, fix small issues, identify tech debt |
261270

262271
#### Optional Commands
263272

@@ -614,6 +623,30 @@ The `/speckit.implement` command will:
614623
615624
Once the implementation is complete, test the application and resolve any runtime errors that may not be visible in CLI logs (e.g., browser console errors). You can copy and paste such errors back to your AI agent for resolution.
616625

626+
### **STEP 8:** Clean up and review
627+
628+
After implementation is complete, use the `/speckit.cleanup` command to perform a final quality review:
629+
630+
```text
631+
/speckit.cleanup
632+
```
633+
634+
The `/speckit.cleanup` command will:
635+
636+
- Review all files modified during implementation
637+
- **Fix small issues immediately** (Scout Rule): Remove debugging artifacts (console.log, print statements), unused imports, dead code, and other mechanical issues
638+
- **Create follow-up tasks** for medium issues: Missing error handling, code duplication, incomplete documentation
639+
- **Generate detailed analysis** for large issues: Architectural concerns, security vulnerabilities, performance bottlenecks - each with multiple options and recommendations
640+
641+
The cleanup phase produces:
642+
643+
- **Direct fixes** committed with clear messages for small issues
644+
- **Tech Debt Tasks section** appended to `tasks.md` for medium issues (can be addressed by re-running `/speckit.implement`)
645+
- **`tech-debt-report.md`** for large issues requiring team discussion, with problem descriptions, impact assessments, and recommended approaches
646+
647+
> [!NOTE]
648+
> The cleanup command will halt on critical security issues (hardcoded credentials, exposed secrets) and require you to fix them before proceeding.
649+
617650
</details>
618651

619652
---

0 commit comments

Comments
 (0)