# Clean Code

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

- **Type:** Skill
- **Install:** `agentstack add skill-paulojalowyj-openkit-clean-code`
- **Verified:** Yes — security-reviewed for prompt injection and unsafe behavior
- **Seller:** [paulojalowyj](https://agentstack.voostack.com/s/paulojalowyj)
- **Installs:** 0
- **Category:** [Agent Skills](https://agentstack.voostack.com/c/agent-skills)
- **Latest version:** 0.1.0
- **License:** MIT
- **Upstream author:** [paulojalowyj](https://github.com/paulojalowyj)
- **Source:** https://github.com/paulojalowyj/openkit/tree/main/.opencode/skills/clean-code
- **Website:** https://linktr.ee/paulojalowyj

## Install

```sh
agentstack add skill-paulojalowyj-openkit-clean-code
```

Requires the [AgentStack CLI](https://agentstack.voostack.com/docs/cli). Works with Claude Code, Cursor, and any MCP-compatible agent.

## About

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

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

```markdown
## 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?**
```

4. **Wait for user confirmation** before fixing
5. **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.

## Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

- **Author:** [paulojalowyj](https://github.com/paulojalowyj)
- **Source:** [paulojalowyj/openkit](https://github.com/paulojalowyj/openkit)
- **License:** MIT
- **Homepage:** https://linktr.ee/paulojalowyj

Install and usage instructions live in the source repository linked above.

## Pricing

- **Free** — Free

## Security capabilities

Automated source analysis of v0.1.0 — what this tool can access:

- **Network access:** no
- **Filesystem access:** no
- **Shell / process execution:** no
- **Environment & secrets:** no
- **Dynamic code execution:** no

*"Yes" means the capability is present in the source — more access means more to trust, not that it is unsafe.*


## Versions

- **0.1.0** — security scan: passed — Imported from the upstream source.

## Links

- Listing page: https://agentstack.voostack.com/l/skill-paulojalowyj-openkit-clean-code
- Seller: https://agentstack.voostack.com/s/paulojalowyj
- Browse the marketplace: https://agentstack.voostack.com/browse

---
Listed on AgentStack — the marketplace for AI agent skills and MCP servers. Every listing is security-reviewed. Creators keep 70%.