Clean Code - Pragmatic AI Coding Standards

clean-code

Pragmatic coding standards - concise, direct, no over-engineering, no unnecessary comments

lchenrique/politron-ide·0installs0stars

SKILL.md

Full skill instructions

Clean Code - Pragmatic AI Coding Standards

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

Core Principles

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

Naming Rules

Element	Convention
Variables	Reveal intent: `userCount` not `n`
Functions	Verb + noun: `getUserById()` not `user()`
Booleans	Question form: `isActive`, `hasPermission`, `canEdit`
Constants	SCREAMING_SNAKE: `MAX_RETRY_COUNT`

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

Function Rules

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

Code Structure

Pattern	Apply
Guard Clauses	Early returns for edge cases
Flat > Nested	Avoid deep nesting (max 2 levels)
Composition	Small functions composed together
Colocation	Keep related code close

AI Coding Style

Situation	Action
User asks for feature	Write it directly
User reports bug	Fix it, don't explain
No clear requirement	Ask, don't assume

Anti-Patterns (DON'T)

❌ Pattern	✅ Fix
Comment every line	Delete obvious comments
Helper for one-liner	Inline the code
Factory for 2 objects	Direct instantiation
utils.ts with 1 function	Put code where used
"First we import..."	Just write code
Deep nesting	Guard clauses
Magic numbers	Named constants
God functions	Split by responsibility

🔴 Before Editing ANY File (THINK FIRST!)

Before changing a file, ask yourself:

Question	Why
What imports this file?	They might break
What does this file import?	Interface changes
What tests cover this?	Tests might fail
Is this a shared component?	Multiple places affected

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

Do	Don't
Write code directly	Write tutorials
Let code self-document	Add obvious comments
Fix bugs immediately	Explain the fix first
Inline small things	Create unnecessary files
Name things clearly	Use abbreviations
Keep functions small	Write 100+ line functions

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

🔴 Self-Check Before Completing (MANDATORY)

Before saying "task complete", verify:

Check	Question
✅ Goal met?	Did I do exactly what user asked?
✅ Files edited?	Did I modify all necessary files?
✅ Code works?	Did I test/verify the change?
✅ No errors?	Lint and TypeScript pass?
✅ Nothing forgotten?	Any edge cases missed?

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

Verification Scripts (MANDATORY)

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

Agent → Script Mapping

Agent	Script	Command
frontend-specialist	UX Audit	`python .agent/skills/frontend-design/scripts/ux_audit.py .`
frontend-specialist	A11y Check	`python .agent/skills/frontend-design/scripts/accessibility_checker.py .`
backend-specialist	API Validator	`python .agent/skills/api-patterns/scripts/api_validator.py .`
mobile-developer	Mobile Audit	`python .agent/skills/mobile-design/scripts/mobile_audit.py .`
database-architect	Schema Validate	`python .agent/skills/database-design/scripts/schema_validator.py .`
security-auditor	Security Scan	`python .agent/skills/vulnerability-scanner/scripts/security_scan.py .`
seo-specialist	SEO Check	`python .agent/skills/seo-fundamentals/scripts/seo_checker.py .`
seo-specialist	GEO Check	`python .agent/skills/geo-fundamentals/scripts/geo_checker.py .`
performance-optimizer	Lighthouse	`python .agent/skills/performance-profiling/scripts/lighthouse_audit.py <url>`
test-engineer	Test Runner	`python .agent/skills/testing-patterns/scripts/test_runner.py .`
test-engineer	Playwright	`python .agent/skills/webapp-testing/scripts/playwright_runner.py <url>`
Any agent	Lint Check	`python .agent/skills/lint-and-validate/scripts/lint_runner.py .`
Any agent	Type Coverage	`python .agent/skills/lint-and-validate/scripts/type_coverage.py .`
Any agent	i18n Check	`python .agent/skills/i18n-localization/scripts/i18n_checker.py .`

❌ WRONG: test-engineer running ux_audit.py ✅ CORRECT: frontend-specialist running ux_audit.py

🔴 Script Output Handling (READ → SUMMARIZE → ASK)

When running a validation script, you MUST:

Run the script and capture ALL output
Parse the output - identify errors, warnings, and passes
Summarize to user in this format:

## Script Results: [script_name.py]

### ❌ Errors Found (X items)
- [File:Line] Error description 1
- [File:Line] Error description 2

### ⚠️ Warnings (Y items)
- [File:Line] Warning description

### ✅ Passed (Z items)
- Check 1 passed
- Check 2 passed

**Should I fix the X errors?**

Wait for user confirmation before fixing
After fixing → Re-run script to confirm

🔴 VIOLATION: Running script and ignoring output = FAILED task. 🔴 VIOLATION: Auto-fixing without asking = Not allowed. 🔴 Rule: Always READ output → SUMMARIZE → ASK → then fix.

Install skill

Copy and run in your terminal

npx -y skills add https://github.com/lchenrique/politron-ide --skill clean-code

View on GitHub

.agent/skills/clean-code/SKILL.md

webapp-testing
Web application testing principles. E2E, Playwright, deep audit strategies.
0 installs
react-patterns
Modern React patterns and principles. Hooks, composition, performance, TypeScript best practices.
0 installs
templates
Project scaffolding templates for new applications. Use when creating new projects from scratch. Contains 12 templates for various tech stacks.
0 installs
bash-linux
Bash/Linux terminal patterns. Critical commands, piping, error handling, scripting. Use when working on macOS or Linux systems.
0 installs

More skills from lchenrique

lchenrique/politron-ide

api-patterns

API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.

0 0

View

lchenrique/politron-ide

deployment-procedures

Production deployment principles and decision-making. Safe deployment workflows, rollback strategies, and verification. Teaches thinking, not scripts.

0 0

View

lchenrique/politron-ide

game-design

Game design principles. GDD structure, balancing, player psychology, progression.

0 0

View

lchenrique/politron-ide

game-audio

Game audio principles. Sound design, music integration, adaptive audio systems.

0 0

View

lchenrique/politron-ide

architecture

Architectural decision-making framework. Requirements analysis, trade-off evaluation, ADR documentation. Use when making architecture decisions or analyzing system design.

0 0

View

lchenrique/politron-ide

mobile-games

Mobile game development principles. Touch input, battery, performance, app stores.

0 0

View

lchenrique/politron-ide

parallel-agents

Multi-agent orchestration patterns. Use when multiple independent tasks can run with different domain expertise or when comprehensive analysis requires multiple perspectives.

0 0

View

lchenrique/politron-ide

brainstorming

Socratic questioning protocol + user communication. MANDATORY for complex requests, new features, or unclear requirements. Includes progress reporting and error handling.

0 0

View

lchenrique/politron-ide