Skip to content

vahmo/clean-engineering-skill

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧱 clean-engineering-skill

A Claude Code Skill that enforces clean software engineering principles automatically — before the first line of code is written. Once installed, Claude Code applies DRY, SOLID, KISS, YAGNI, and architectural best practices on every project, feature, class design, and API endpoint, across any stack or project size.

License Stacks Type


What it covers

  • ✅ DRY — Don't Repeat Yourself
  • ✅ KISS — Keep It Simple, Stupid
  • ✅ YAGNI — You Ain't Gonna Need It
  • ✅ SOLID — Single Responsibility
  • ✅ SOLID — Open/Closed
  • ✅ SOLID — Liskov Substitution
  • ✅ SOLID — Interface Segregation
  • ✅ SOLID — Dependency Inversion
  • ✅ Composition over Inheritance
  • ✅ Naming Standards (camelCase, PascalCase, UPPER_SNAKE_CASE, snake_case, kebab-case)
  • ✅ Comment Guidelines (explain why, not what)
  • ✅ Anti-Patterns blacklist
  • ✅ Pre-Flight Checklist (5 questions before any file)
  • ✅ Pre-Commit Checklist (8 validations before finishing)

Supported Stacks

Next.js · Laravel · FastAPI · Prisma · PostgreSQL · Redis · Docker — and any other stack.


Installation

Option 1 — Direct skill file install

  1. Download SKILL.md
  2. In Claude Code, run:
/install-skill path/to/SKILL.md

Option 2 — Clone and install

git clone https://github.com/vahmo/clean-engineering-skill.git
cd clean-engineering-skill
# In Claude Code:
/install-skill SKILL.md

How it works

After installation, Claude Code will:

  1. Run the Pre-Flight Checklist — answer 5 mandatory questions before writing any file
  2. Apply SOLID principles — every class and module is designed with a single responsibility and abstraction-based dependencies
  3. Enforce DRY — detect and eliminate duplicated logic across the codebase
  4. Block Anti-Patterns — God Classes, Magic Numbers, Callback Hell, and others are refused before they enter the code
  5. Validate before finishing — run the Pre-Commit Checklist across all 8 criteria before marking a task complete

What It Enforces

  • Pre-Flight Checklist — 5 mandatory questions (SRP, DRY, YAGNI, KISS, DIP) before writing any file
  • Anti-Pattern Blocking — refuses God Classes, Magic Numbers, Callback Hell, Props Drilling, and more
  • Pre-Commit Validation — 8 quality checks before marking any task complete

See SKILL.md for the full checklists, rules, and code examples.


Stack-Specific Reference Files

File Stack
references/nextjs-patterns.md Next.js + TypeScript
references/laravel-patterns.md Laravel (PHP)
references/fastapi-patterns.md FastAPI (Python)
references/database-patterns.md Prisma / PostgreSQL

Contributing

Contributions are welcome. See CONTRIBUTING.md for guidelines on:

  • Adding new anti-patterns
  • Adding framework-specific reference files
  • Reporting issues
  • Submitting pull requests

License

MIT — see LICENSE. Free to use, modify, and distribute.

About

A Claude Code skill that enforces clean engineering principles — SOLID, DRY, KISS, YAGNI

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors