What problem does it solve?
This Skill enforces a set of pragmatic coding standards to ensure code is concise, direct, maintainable, and avoids over-engineering or unnecessary complexity.
Core Features & Use Cases
- Enforces SOLID principles: Promotes Single Responsibility, Don't Repeat Yourself, Keep It Simple, and You Aren't Gonna Need It.
- Establishes clear naming conventions: For variables, functions, booleans, and constants.
- Defines function best practices: Emphasizes small size, single responsibility, and minimal arguments.
- Guides code structure: Recommends guard clauses, flat structures, and composition.
- Provides AI-specific coding guidelines: For handling user requests and bug fixes.
- Includes self-check mechanisms: For agents to verify their work before completion.
- Mandates script verification: Ensures agents run and interpret validation scripts correctly.
Quick Start
Apply the clean-code skill to refactor the provided code snippet for improved readability and maintainability.