What problem does it solve?
Reduces long-term maintenance costs by transforming confusing, brittle code into clear, readable implementations that other developers can confidently extend.
Core Features & Use Cases
- Meaningful naming: Uses intention-revealing identifiers, correct distinctions, and consistent conventions to make behavior obvious.
- Function design: Encourages small, single-purpose functions, sensible abstractions, and minimal side effects.
- Clean commenting and formatting: Recommends rewriting bad code instead of hiding it behind comments, and using formatting that improves scanability.
- Data structure and error handling guidance: Promotes encapsulation, avoids “train wrecks” through better interfaces, and uses robust error-handling practices.
- Testing and heuristics: Applies unit-testing principles (F.I.R.S.T.) and common smell detection to guide refactors safely.
Quick Start
Use the clean-code skill to review a recent pull request and rewrite the worst naming, function size, and error-handling issues for readability and maintainability.