clean-code

Enforce pragmatic coding standards for AI agents with self-checks and verification scripts.

Updated Nov 12, 2025
One-click install
npx skills add https://github.com/jabez4jc/Simplifyed --skill clean-code-jabez4jc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: clean-code
Source: https://github.com/jabez4jc/Simplifyed/tree/main/.agent/skills/clean-code
Command: npx skills add https://github.com/jabez4jc/Simplifyed --skill clean-code-jabez4jc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill enforces pragmatic coding standards to ensure code is maintainable, efficient, and easy to understand, preventing over-engineering and unnecessary complexity.

Core Features & Use Cases

  • Enforces Core Principles: Adheres to SRP, DRY, KISS, YAGNI, and the Boy Scout Rule.
  • Clear Naming Conventions: Guides on naming variables, functions, booleans, and constants for better readability.
  • Function & Code Structure Guidelines: Promotes small functions, guard clauses, and flat code structures.
  • AI Coding Style: Directs AI agents on how to respond to user requests (write code directly, fix bugs, ask when unclear).
  • Self-Check Mandates: Ensures agents verify goals, file edits, code functionality, and error-free states before completion.
  • Verification Scripts: Outlines mandatory script execution for linting, type coverage, and other checks.

Quick Start

Apply the clean-code skill to refactor the provided Python function for improved readability and adherence to single responsibility.

Frequently Asked Questions about clean-code

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce clean code standards when refactoring code with an AI agent?

Clean code guidelines for AI agents mandate direct code generation, bug fixing, and asking for clarification when requirements are unclear. This interaction style prevents unnecessary complexity and ensures solution-oriented responses.

What is the best way to structure functions for better readability and maintainability?

Before completing a task, clean code standards require mandatory self-checks to verify goals, file edits, and code functionality. This ensures an error-free state before finalizing any code modifications.

How do you prevent over-engineering and unnecessary complexity in software development?

Preventing over-engineering requires adhering to YAGNI (You Aren't Gonna Need It) and KISS (Keep It Simple, Stupid) principles. This pragmatic approach ensures code remains efficient, concise, and strictly solution-oriented.

Does writing clean code require running verification scripts for quality assurance?

Yes, writing clean code includes mandatory verification script execution for linting, type coverage, and other checks. This automated quality assurance validates that the code meets required standards and is error-free.

Can I use the Boy Scout Rule to guide AI coding style and code structure?

Yes, you can use the Boy Scout Rule to guide AI coding style by ensuring agents leave code cleaner than they found it. This involves applying core principles like DRY and SRP to maintain efficient code structure.