agentleFS
grndlvlgrndlvl/software-patterns/.claude/skills/clean-code/SKILL.md

clean-code

Skill17 starsChanged 9 months agoMITView on GitHub

Clean Code principles and practices reference based on Robert Martin's work. Use this skill when reviewing code quality, naming conventions, refactoring, or applying SOLID principles. Auto-activates for code smell detection, style improvements, and maintainability concerns.

108 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use intelligent-routing, nextjs-react-expert and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • SKB3002Skill

    intelligent-routing

    Automatic agent selection and intelligent task routing. Analyzes user requests and automatically selects the best specialist agent(s) without requiring explicit user mentions.

    Also in 5 projects that use this

  • SKB3002Skill

    nextjs-react-expert

    React and Next.js performance optimization from Vercel Engineering. Use when building React components, optimizing performance, eliminating waterfalls, reducing bundle size, reviewing code for performance issues, or implementing server/client-side optimizations.

    Also in 3 projects that use this

  • xfstudioSkill

    bash-pro

    Master of defensive Bash scripting for production automation, CI/CD

    Also in 4 projects that use this

  • xfstudioSkill

    code-refactoring-tech-debt

    You are a technical debt expert specializing in identifying, quantifying, and prioritizing technical debt in software projects. Analyze the codebase to uncover debt, assess its impact, and create acti

    Also in 4 projects that use this

  • flying-diceSkill

    clean-code-review

    Multi-agent clean code audit — each principle gets its own agent

    Also in 3 projects that use this

  • goca-seSkill

    batch-operations

    Apply a change safely across many files — refactors touching more than 5 files, library or API migrations, project-wide renames of symbols/imports/paths, or adding boilerplate to many files. Use when "do it all at once" risks context overflow or silent failures.

    Also in 3 projects that use this

  • +4 more from xfstudio

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 101 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Write or review unit tests

    line 18
  2. Distinctive:

    Every time you touch code, make it a little better.

    line 47
  3. Distinctive:

    Before committing code, verify:

    line 51

“Common” is measured: kept by at least 6 in 10 of the 101 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Clean Code Reference

A comprehensive reference for writing clean, maintainable code based on Robert Martin's "Clean Code" and related works. This skill provides language-agnostic principles with examples that apply to any programming language.

When This Skill Activates

This skill automatically activates when you:

  • Review code for quality or maintainability
  • Need guidance on naming conventions
  • Discuss refactoring or code smells
  • Apply SOLID principles
  • Improve code readability or structure
  • Write or review unit tests

Quick Reference

SOLID Principles

PrincipleSummaryViolation Sign
Single Responsibility (SRP)One reason to changeClass does too many things
Open/Closed (OCP)Open for extension, closed for modificationModifying existing code for new features
Liskov Substitution (LSP)Subtypes must be substitutableSubclass breaks parent behavior
Interface Segregation (ISP)No forced dependencies on unused methodsFat interfaces
Dependency Inversion (DIP)Depend on abstractions, not concretionsHigh-level modules import low-level

Clean Code Practices

PracticeKey Points
Meaningful NamesIntention-revealing, pronounceable, searchable
FunctionsSmall, do one thing, one level of abstraction
CommentsCode should be self-documenting; comments explain why, not what
FormattingConsistent style, vertical density, horizontal alignment
Error HandlingExceptions over error codes, fail fast, don't return null
Unit TestingF.I.R.S.T. principles, one assert per test, test behavior
Code SmellsRecognition and refactoring of common problems
Boy Scout RuleLeave code cleaner than you found it

The Boy Scout Rule

"Leave the campground cleaner than you found it."

Every time you touch code, make it a little better. Small, incremental improvements compound over time.

Code Quality Checklist

Before committing code, verify:

  • Names - Are all names intention-revealing?
  • Functions - Is each function doing exactly one thing?
  • Comments - Are comments explaining why, not what?
  • DRY - Is there any duplicated logic?
  • SOLID - Are principles being followed?
  • Tests - Is the code tested and testable?
  • Error Handling - Are errors handled gracefully?

Language Translation Notes

Examples use generic pseudocode. Adapt to your language:

  • PHP: class, function, ->, type hints
  • JavaScript/TypeScript: class, arrow functions, .
  • Python: class, def, ., type hints
  • Java/C#: Direct mapping with access modifiers

Based on concepts from "Clean Code: A Handbook of Agile Software Craftsmanship" by Robert C. Martin, 2008.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.