clean-code

Topics in the source

• Clean Code - Pragmatic AI Coding Standards
• Core Principles
• Naming Rules
• Function Rules
• Code Structure
• AI Coding Style
• Anti-Patterns (DON'T)
• 🔴 Before Editing ANY File (THINK FIRST!)

CRITICAL SKILL - Be concise, direct, and solution-focused. -- | Principle | Rule | |-----------|------| | SRP | Single Responsibility - each function/class does ONE thing | | DRY | Don't Repeat Yourself - extract duplicates, reuse | | KISS | Keep It Simple - simplest solution that works | | YAGNI | You Aren't Gonna Need It - don't build unused features | | Boy Scout | Leave code cleaner than you found it | -- | Element | Convention | |---------|------------| | Variables | Reveal intent: userCount not n | | Functions | Verb + noun: getUserById() not user() | | Booleans | Question form: isActive, hasPermission, canEdit | | Constants | SCREAMINGSNAKE: MAXRETRYCOUNT | Rule: If you need a comment to explain a name, rename it. -- | Rule | Description | |------|-------------| | Small | Max 20 lines, ideally 5-10 | | One Thing | Does one thing, does it well | | One Level | One level of abstraction per function | | Few Args | Max 3 arguments, prefer 0-2 | | No Side Effects | Don't mutate inputs unexpectedly | -- | Pattern | Apply | |---------|-------| | Guard Clauses | Early returns for edge cases | | Flat > Nested | Avoid deep nesting (max 2 levels) | | Composition | Small functions compos

This is an excerpt. Refer to the complete source and its current requirements.