clean-code

Refactoring Python code for maintainability involves enforcing pragmatic standards like SRP, DRY, and KISS to eliminate unnecessary complexity. This skill guides AI agents to apply these principles, ensuring concise, direct, and solution-oriented code.

Best practices for clean code in AI development mandate strict naming conventions, small focused functions with minimal arguments, and guard clauses. This skill defines AI coding etiquette, requiring pre-edit checks and post-completion self-verification to ensure functionality.

Applying SOLID principles to Python scripts requires checking for Single Responsibility, avoiding repetition, and keeping implementations simple. This skill enforces these standards alongside the Boy Scout Rule, ensuring code remains clean and maintainable.

Yes, script execution for validation is mandatory in this clean code approach. It requires running scripts post-completion to verify goal achievement, confirm error-free status, and report functionality before finalizing any refactoring or new code.

You can use this skill to implement function design guidelines by advocating for small, focused functions without side effects. It also standardizes naming conventions across variables and constants, ensuring clear and intent-revealing code structures.

Before modifying files, you should perform critical pre-edit checks considering dependencies and tests. This skill mandates evaluating these factors upfront to prevent breaking existing functionality and to maintain structural integrity during refactoring.