general-best-practices

Provides code review and refactoring guidance for improving code quality and maintainability.

Updated Jan 23, 2026

Search Tags:#refactoring #code-quality #immutability #clean-code #code-smells #review-checklist

Ready to run

npx skills add https://github.com/hossam7amdy/easy-auth --skill general-best-practices

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: general-best-practices
Source: https://github.com/hossam7amdy/easy-auth/tree/main/.agent/skills/general-best-practices
Command: npx skills add https://github.com/hossam7amdy/easy-auth --skill general-best-practices

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

General Best Practices: Code Quality & Clean Code helps teams produce readable, maintainable, and reliable software by teaching and enforcing proven guidelines and refactor patterns.

Core Features & Use Cases

Identify and eliminate code smells via targeted refactors.
Enforce naming conventions, immutability, error handling, and modular design through review checklists.
Provide scalable guidance for legacy code improvement and PR reviews in real projects.
Use Case: A team revamps a legacy module to reduce churn and improve onboarding.

Quick Start

Begin by running a quick code-review pass using the guidelines to spot long functions, duplicated logic, unclear names, and mutable patterns, then apply the recommended refactor steps to improve structure and readability.

Frequently Asked Questions about general-best-practices

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

FAQPage Schema

How do I identify code smells and refactoring opportunities in a legacy module?▼

Run a structured code-review pass to spot long functions, duplicated logic, unclear names, and mutable patterns, then apply targeted refactor steps to improve structure, readability, and maintainability.

What is the best way to enforce immutability and naming conventions during PR reviews?▼

Apply comprehensive review checklists during PR reviews to enforce explicit naming, mutation avoidance, error handling, and modular design, ensuring clean code standards are met consistently.

When do I need clean code guidelines for software engineering projects?▼

Clean code guidelines are needed when revamping legacy modules to reduce churn, improving onboarding, and executing refactoring tasks to produce readable, maintainable, and reliable software.

Does this approach work for reducing code duplication and improving modular design?▼

Yes, this approach provides scalable guidance to reduce duplication and enforce modular design through targeted refactors, satisfying maintainability requirements across typical software projects.

What are the limitations of using general clean code checklists for code quality?▼

General checklists provide structured guidance but lack automated enforcement, requiring manual application during code reviews and refactoring tasks to eliminate code smells and achieve maintainability.