What problem does it solve?
This Skill enforces pragmatic coding standards to ensure code is concise, understandable, and avoids unnecessary complexity, leading to more maintainable and robust software.
Core Features & Use Cases
- Enforces SOLID principles: Promotes Single Responsibility, DRY, KISS, YAGNI.
- Standardizes Naming Conventions: Ensures variables, functions, and constants are clearly named.
- Optimizes Function Design: Guides towards small, focused functions with minimal arguments.
- Promotes Clean Code Structure: Encourages guard clauses, flat nesting, and composition.
- AI Coding Style Guidelines: Directs AI agents on how to interact with users for code generation and bug fixing.
- Pre-edit Checks: Mandates thinking about dependencies and impact before modifying files.
- Post-completion Self-Checks: Ensures all requirements are met, code works, and tests pass.
- Mandatory Script Verification: Defines specific scripts for agents to run for validation.
Quick Start
Follow the clean code principles to refactor the provided code snippet for better readability and maintainability.