clean-code

Guide developers in writing concise, well-named code with clear structure.

1|Updated Jun 23, 2026
One-click install
npx skills add https://github.com/phuonghx/aim-cli --skill clean-code-phuonghx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: clean-code
Source: https://github.com/phuonghx/aim-cli/tree/main/aim/templates/aim-agents/skills/clean-code
Command: npx skills add https://github.com/phuonghx/aim-cli --skill clean-code-phuonghx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides guidelines for writing code that adheres to pragmatic coding standards, enhancing readability, maintainability, and performance.

Core Features & Use Cases

  • Guiding Principles: Emphasizes one job per unit, avoiding duplication, favoring the simplest solution, and building only what's needed.
  • Naming Conventions: Defines conventions for variables, functions, booleans, and constants.
  • Function Structure: Encourages short, focused, single-altitude functions with lean signatures.
  • Code Organization: Promotes shallow nesting, guard clauses, and keeping related code close.
  • Response Strategy: Suggests direct coding practices, such as writing feature code directly and fixing bugs immediately.
  • Anti-Patterns: Outlines anti-patterns to avoid, like unnecessary annotations and god functions.
  • File Editing: Advises on how to think before editing a file to minimize ripple effects.
  • Self-Check: Offers a checklist for self-evaluation before declaring code finished.
  • Validation Scripts: Instructs on handling validation scripts for code quality assurance.
  • Use Case: A developer uses this Skill to review and improve the code quality of their project, adhering to best practices.

Quick Start

Implement the clean-code practices in your project to enhance the quality and maintainability of your code.

Frequently Asked Questions about clean-code

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

FAQPage Schema
What are the best practices for writing readable and maintainable code?

Best practices for readable code involve using clear naming conventions, writing short single-altitude functions, favoring the simplest solution, and avoiding god functions to improve maintainability and performance.

How do I organize function structure to prevent god functions?

To prevent god functions, structure your functions to do one job per unit, maintain lean signatures, and keep nesting shallow, ensuring each function operates at a single altitude of abstraction.

What naming conventions should I use for variables, booleans, and constants?

Naming conventions for variables, booleans, and constants should be direct and concise, adhering to pragmatic coding standards that enhance code readability and maintainability across the project.

How do I minimize ripple effects when editing a file?

To minimize ripple effects when editing a file, think before editing, keep related code close, and use guard clauses to flatten nesting, which maintains code organization and stability.

Can I use these coding standards for any software development project?

Yes, you can apply these coding standards to any software development project, as the guidelines focus on universal practices for code quality, organization, and performance improvement.

What anti-patterns should I avoid to ensure concise code?

To ensure concise code, avoid anti-patterns such as unnecessary annotations, god functions, and deep nesting, which hinder readability and violate the principle of building only what is needed.