One-click install
npx skills add https://github.com/btwitskaif69/Markify --skill clean-code-btwitskaif69
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: clean-code
Source: https://github.com/btwitskaif69/Markify/tree/main/.agent/skills/clean-code
Command: npx skills add https://github.com/btwitskaif69/Markify --skill clean-code-btwitskaif69

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill enforces pragmatic coding standards to ensure code is maintainable, efficient, and easy to understand, preventing over-engineering and unnecessary complexity.

Core Features & Use Cases

  • Enforces SOLID principles: Promotes Single Responsibility, Don't Repeat Yourself, Keep It Simple, and You Ain't Gonna Need It.
  • Standardizes Naming Conventions: Ensures clear and intent-revealing names for variables, functions, and constants.
  • Optimizes Code Structure: Encourages guard clauses, flat nesting, and composition over deep hierarchies.
  • Use Case: When asked to implement a new feature, the AI will write the code directly, adhering to these standards, rather than providing a lengthy explanation or over-engineered solution.

Quick Start

Apply the clean-code skill to refactor the provided user authentication module for improved readability and maintainability.

Frequently Asked Questions about clean-code

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce clean code standards in AI-generated code?

To enforce clean code standards in AI-generated code, apply a skill that mandates principles like SRP, DRY, KISS, and YAGNI, along with strict naming conventions and self-check verification scripts to ensure conciseness and maintainability.

What is the best way to refactor a module for improved readability and maintainability?

The best way to refactor for readability and maintainability involves enforcing SOLID principles, standardizing naming conventions, and optimizing code structure by using guard clauses, flattening nesting, and favoring composition over deep hierarchies.

How do I prevent over-engineering when implementing a new feature?

To prevent over-engineering when implementing a new feature, mandate adherence to the YAGNI (You Ain't Gonna Need It) and KISS (Keep It Simple) principles, directing the AI to write concise, solution-oriented code without unnecessary complexity.

Does the clean-code skill include automated verification scripts?

Yes, the clean-code skill includes specific verification scripts and self-check mechanisms that agents run post-task completion to validate that the generated code adheres to pragmatic coding standards and structural guidelines.

Can I use this skill to standardize naming conventions across my variables and functions?

Yes, you can use this skill to standardize naming conventions, as it explicitly enforces clear and intent-revealing names for variables, functions, and constants to prevent ambiguity and improve code quality.

When do I need pragmatic coding standards for my development workflow?

You need pragmatic coding standards when your codebase suffers from unnecessary complexity, deep nesting, or repetitive patterns, ensuring your code remains maintainable, efficient, and easy to understand as the project scales.