What problem does it solve?
This Skill enforces pragmatic coding standards to ensure code is simple, maintainable, and directly addresses the problem without unnecessary complexity or verbosity.
Core Features & Use Cases
- Enforces SOLID principles: Promotes Single Responsibility, Don't Repeat Yourself, Keep It Simple, You Ain't Gonna Need It, and the Boy Scout Rule.
- Clear Naming Conventions: Guides on naming variables, functions, and constants for maximum readability.
- Function Best Practices: Defines rules for function size, arguments, and side effects.
- Code Structure Guidelines: Advocates for guard clauses, flat nesting, composition, and colocation.
- AI Coding Style: Directs AI agents on how to respond to user requests for features, bugs, or unclear requirements.
- Self-Check Mechanism: Mandates a rigorous self-verification process before task completion.
- Script Verification: Outlines how to run and interpret validation scripts.
Quick Start
Apply the clean code principles to refactor the provided Python function to be more concise and readable.