What problem does it solve?
This Skill helps developers write, review, and refactor code to meet high standards of quality, readability, and maintainability, reducing technical debt and improving collaboration.
Core Features & Use Cases
- Meaningful Naming: Guides the creation of descriptive and intention-revealing names for variables, functions, and classes.
- Function Design: Promotes writing small, single-purpose functions with clear arguments and no side effects.
- Comment Best Practices: Encourages explaining code through clarity rather than excessive comments.
- Error Handling: Advocates for using exceptions and avoiding null returns.
- Use Case: When writing a new feature, use this skill to ensure your code adheres to established best practices for naming, function structure, and error handling, making it easier for teammates to understand and maintain.
Quick Start
Apply the clean-code skill to refactor the provided Python function to improve its readability and adherence to best practices.