24 lines
1.2 KiB
Markdown
24 lines
1.2 KiB
Markdown
---
|
|
name: code_quality_expert
|
|
description: Foundational skill for enforcing general code quality standards, SOLID principles, and software engineering best practices.
|
|
---
|
|
|
|
# Code Quality Expert Skill
|
|
|
|
This skill ensures that all code produced or reviewed by the agent adheres to high-quality software engineering standards, regardless of the target language.
|
|
|
|
## Principles
|
|
|
|
1. **SOLID Principles**: Ensure single responsibility, open-closed, Liskov substitution, interface segregation, and dependency inversion.
|
|
2. **DRY (Don't Repeat Yourself)**: Avoid redundant logic by abstracting it into reusable components.
|
|
3. **KISS (Keep It Simple, Stupid)**: Prioritize simple, readable code over clever, complex solutions.
|
|
4. **Meaningful Naming**: Use descriptive and consistent names for variables, functions, and classes.
|
|
5. **Testability**: Design code that is easy to test using unit, integration, and end-to-end tests.
|
|
6. **Style Guide Adherence**: Enforce language-specific style guides (e.g., Google Python Style Guide, PEP 8) in the public domain.
|
|
|
|
## Code Quality Checklist
|
|
- Is the code readable and well-documented?
|
|
- Are there any potential performance or security risks?
|
|
- Is the error handling robust and appropriate?
|
|
- Are there any architectural violations?
|