clean-code

Solid

Code quality: meaningful names, SRP, DRY, small functions, guard clauses, refactoring. Triggers: clean code, naming, code smell, SRP, DRY, long function, god class, dead code.

AI & Automation 155 stars 19 forks Updated 2 days ago MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
73
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Clean Code Skill ## Core Principles ### 1. Meaningful Names ```python # Bad def calc(a, b): return a * b # Good def calculate_total_price(unit_price: float, quantity: int) -> float: return unit_price * quantity ``` ### 2. Single Responsibility ```python # Bad - does too much def process_user(user_data): validate(user_data) user = create_user(user_data) send_welcome_email(user) log_creation(user) return user # Good - each function does one thing def create_user(user_data: UserData) -> User: return User(**user_data) def onboard_user(user_data: UserData) -> User: user = create_user(user_data) send_welcome_email(user) log_user_creation(user) return user ``` ### 3. DRY (Don't Repeat Yourself) ```python # Bad def get_active_users(): return [u for u in users if u.status == "active"] def get_active_admins(): return [u for u in users if u.status == "active" and u.role == "admin"] # Good def filter_users(status: str | None = None, role: str | None = None) -> list[User]: result = users if status: result = [u for u in result if u.status == status] if role: result = [u for u in result if u.role == role] return result ``` --- ## Code Organization Keep modules focused. Order contents consistently: imports (stdlib, third-party, local), constants, public API, private helpers. Use clear visibility markers (underscore prefix in Python, access modifiers in other languages). Group related func...

Details

Author
softspark
Repository
softspark/ai-toolkit
Created
2 months ago
Last Updated
2 days ago
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category