What problem does it solve?
This Skill enforces pragmatic coding standards to ensure code is concise, direct, and avoids over-engineering or unnecessary comments, leading to more maintainable and understandable software.
Core Features & Use Cases
- Enforces SOLID principles: Promotes Single Responsibility, Don't Repeat Yourself, Keep It Simple, You Aren't Gonna Need It, and the Boy Scout Rule.
- Standardizes Naming Conventions: Ensures clear and intent-revealing names for variables, functions, and constants.
- Optimizes Function Design: Guides the creation of small, focused functions with minimal arguments and no side effects.
- Promotes Clean Code Structure: Encourages guard clauses, flat code, and composition over deep nesting.
- AI Coding Style Guidelines: Directs AI agents on how to respond to user requests, fix bugs, and handle unclear requirements.
- Pre-computation Checks: Mandates thinking about dependencies and potential impacts before editing files.
- Post-completion Verification: Requires self-checking for goal completion, code correctness, and error-free execution.
- Script Execution & Reporting: Defines how validation scripts should be run, their output interpreted, and user confirmation sought for fixes.
Quick Start
Follow the clean code principles to refactor the provided user authentication module for better readability and maintainability.