What problem does it solve?
This Skill helps maintain clean and maintainable code by adhering to pragmatic coding standards, ensuring code quality and readability.
Core Features & Use Cases
- Pragmatic Coding Principles: Implements the Single Responsibility Principle, Don't Repeat Yourself, Keep It Simple, You Aren't Gonna Need It, and Boy Scout Rule.
- Naming Conventions: Provides guidelines for naming variables, functions, booleans, and constants to enhance readability.
- Function Rules: Enforces best practices for function size, argument count, and side effects to improve maintainability.
- Code Structure: Recommends guard clauses, flat structures, composition, and colocation for clear and manageable code.
- AI Coding Style: Offers guidelines for AI coding, emphasizing direct implementation, immediate bug fixes, and clarity over requirements.
- Anti-Patterns: Highlights common coding mistakes and their recommended fixes to avoid common pitfalls.
- Pre-Editing Checklist: Ensures all necessary checks are performed before modifying a file, preventing potential issues.
- Summary: Provides a concise list of best practices and don'ts to follow when writing code.
- Self-Check: Ensures all tasks are completed successfully before finalizing work.
- Verification Scripts: Ensures the integrity of the codebase by running verification scripts before completion.
Quick Start
Before editing any file, perform the necessary checks and run all verification scripts for your changes.
