What problem does it solve?
Provides pragmatic coding standards to eliminate over-engineering, unclear names, large god-functions, excessive comments, and inconsistent structure so code is easier to read, maintain, and verify by both humans and AI agents.
Core Features & Use Cases
- Clear Principles: Enforces SRP, DRY, KISS, YAGNI and the Boy Scout rule to keep code small and focused.
- Practical Rules: Naming conventions, function size and arg limits, guard clauses, and composition guidance to reduce bugs and cognitive load.
- Validation Workflow: Mandatory self-check checklist and scripted verification output handling for running, parsing, summarizing, and re-running validation tools before marking work complete.
- Use Case: Use when refactoring a legacy module, implementing a new user-facing feature, or guiding an AI agent to produce production-quality patches.
Quick Start
Refactor and simplify the touched files to follow single-responsibility, small functions with clear names, remove unnecessary comments, run the verification scripts, summarize results, and ask before fixing reported errors.