clean-code

Guide clean coding practices for maintainable, readable code.

Updated Aug 23, 2026

Search Tags:#code review #clean code #coding standards #programming best practices #maintainable code

Ready to run

npx skills add https://github.com/PAISHU-AI/PAI-zong-NB --skill clean-code-paishu-ai

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: clean-code
Source: https://github.com/PAISHU-AI/PAI-zong-NB/tree/main/skills/clean-code
Command: npx skills add https://github.com/PAISHU-AI/PAI-zong-NB --skill clean-code-paishu-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires None, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill provides guidance on writing clean code by adhering to best practices for maintainability and clarity.

Core Features & Use Cases

Core Principles: Adhere to single responsibility, DRY, KISS, YAGNI, and Boy Scout rules.
Naming Rules: Establish conventions for variables, functions, booleans, and constants.
Function Rules: Maintain small, one thing per function, and maintainable structure.
AI Coding Style: Direct implementation and bug fixes, and minimal comment overhead.

Quick Start

Before making changes, run python3 ~/.codex/skills/clean-code/scripts/pre-edit-check.py <file>.

Frequently Asked Questions about clean-code

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

FAQPage Schema

How do I apply clean code principles to simplify future code maintenance?▼

Apply clean code principles by adhering to single responsibility, DRY, KISS, and YAGNI rules to maintain code quality, enhance readability, and simplify future maintenance.

What are the best practices for writing maintainable functions and naming conventions?▼

Maintainable functions require keeping them small and focused on one task, while naming conventions for variables, booleans, and constants must be clear and consistent to reduce complexity.

How do I use coding standards for AI-assisted code review?▼

Use coding standards to guide AI-assisted code review by enforcing direct implementation, minimal comment overhead, and structural best practices to ensure clarity.

Do I need any dependencies to run the clean code pre-edit check?▼

You do not need any dependencies to run the pre-edit check; simply execute the Python script directly before making changes to evaluate your code quality.

Why should I eliminate unnecessary comments and over-engineering in my codebase?▼

Eliminate unnecessary comments and over-engineering to ensure your codebase remains concise, direct, and maintainable, preventing bloated logic and reducing future technical debt.

When should I not use the Boy Scout rule for code refactoring?▼

Avoid using the Boy Scout rule when a module requires massive architectural changes, as small incremental cleanups might conflict with broader structural redesigns and destabilize the system.