Clean Code

Clean Code - Pragmatic AI Coding Standards

CRITICAL SKILL - Be concise, direct, and solution-focused.

Core Principles

Naming Rules

Rule: If you need a comment to explain a name, rename it.

Function Rules

Code Structure

AI Coding Style

Anti-Patterns (DON'T)

🔴 Before Editing ANY File (THINK FIRST!)

Before changing a file, ask yourself:

Quick Check:

File to edit: UserService.ts
└── Who imports this? → UserController.ts, AuthController.ts
└── Do they need changes too? → Check function signatures

🔴 Rule: Edit the file + all dependent files in the SAME task. 🔴 Never leave broken imports or missing updates.

Summary

Remember: The user wants working code, not a programming lesson.

🔴 Self-Check Before Completing (MANDATORY)

Before saying "task complete", verify:

🔴 Rule: If ANY check fails, fix it before completing.

🔴 Terminal Hygiene (CRITICAL)

Always check running terminals for background errors (e.g., webpack/vite build failures, proxy errors).

• Read outputs of dev, start, or watch tasks.
• Ignore them at your own peril.

Verification Commands (MANDATORY)

🔴 CRITICAL: Each agent runs ONLY their own skill's checks after completing work.

Agent → Command Mapping

❌ WRONG: security running npm run test (inefficient). ✅ CORRECT: tdd-jest running npm run test (verifies functionality).

🔴 Command Output Handling

When running a validation command, you MUST:

1. Run the command and capture ALL output.
2. Parse the output - identify errors, warnings, and passes.
3. Summarize if there are failures, fix them before notifying the user.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.