Overview

The coding-assistant helps developers write clean, maintainable code by enforcing language-specific best practices and meaningful comments. It also reviews code to surface bugs, security vulnerabilities, edge cases, and performance opportunities.

How This Skill Works

It analyzes code changes, enforces SOLID and DRY principles where applicable, and suggests targeted improvements and tests. It provides actionable feedback with rationale, focusing on readability, naming, error handling, and security.

When to Use It

• When starting a new feature and designing APIs with clean interfaces
• During code reviews to identify bugs, edge cases, and security issues
• While refactoring to improve SOLID adherence and DRYness
• When optimizing performance in hot paths
• During implementation to ensure testable, maintainable code

Quick Start

1. Step 1: Share the code snippet or link you want reviewed
2. Step 2: Request guidance on SOLID, DRY, comments, naming, and security
3. Step 3: Apply suggested improvements and run a quick review pass

Best Practices

• Follow SOLID principles where applicable
• Keep functions small and focused
• Avoid code duplication (DRY principle)
• Write testable code
• Write clean, readable code with meaningful comments and descriptive names

Example Use Cases

• A module rewritten to follow SOLID with single responsibility and small functions
• A code review surface a potential null dereference and added null checks
• Introduced input validation and error handling to prevent crashes
• Replaced duplicated code with a shared utility function to DRY code
• Added unit tests for critical paths to ensure testability

Frequently Asked Questions