clean-code-principles

Community

Write simple, readable, maintainable code.

Authormarcioaltoe
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill guides developers in writing simple, readable, and maintainable code by applying core Clean Code principles. It helps avoid over-engineering, unnecessary complexity, and code duplication, leading to more robust and understandable software.

Core Features & Use Cases

  • KISS (Keep It Simple, Stupid): Encourages solutions that are as simple as possible, avoiding premature optimization and complex abstractions.
  • YAGNI (You Aren't Gonna Need It): Promotes building only what is currently required by the business, preventing speculative features and unused code.
  • DRY (Don't Repeat Yourself): Advocates for abstracting common logic after the "Rule of Three" to reduce duplication and improve maintainability.
  • TDA (Tell, Don't Ask): Guides objects to command actions rather than querying state and then acting on it, improving encapsulation.
  • Use Case: "Review this new feature implementation to ensure it adheres to the YAGNI principle, removing any speculative code that isn't part of the current requirements."

Quick Start

Refactor a function to simplify its logic, applying the KISS principle.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: clean-code-principles
Download link: https://github.com/marcioaltoe/claude-craftkit/archive/main.zip#clean-code-principles

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository