What problem does it solve?
This Skill enforces pragmatic coding standards to ensure code is maintainable, efficient, and easy to understand, preventing over-engineering and unnecessary complexity.
Core Features & Use Cases
- Enforces Core Principles: Adheres to SRP, DRY, KISS, YAGNI, and the Boy Scout Rule.
- Clear Naming Conventions: Guides on naming variables, functions, booleans, and constants for better readability.
- Function & Code Structure Guidelines: Promotes small functions, guard clauses, and flat code structures.
- AI Coding Style: Directs AI agents on how to respond to user requests (write code directly, fix bugs, ask when unclear).
- Self-Check Mandates: Ensures agents verify goals, file edits, code functionality, and error-free states before completion.
- Verification Scripts: Outlines mandatory script execution for linting, type coverage, and other checks.
Quick Start
Apply the clean-code skill to refactor the provided Python function for improved readability and adherence to single responsibility.