abbreviation-policy

What problem does it solve?

This Skill addresses the common problem of inconsistent and overly abbreviated identifiers in codebases, which hinders readability, maintainability, and onboarding.

Core Features & Use Cases

• Abbreviation Guidelines: Provides a framework for deciding when abbreviations are acceptable and lists universally understood abbreviations.
• Consistency Enforcement: Emphasizes the critical rule that chosen forms (abbreviated or full) must be used consistently across the entire codebase.
• Use Case: When reviewing code, this Skill helps identify and correct instances where msg is used in one file and message in another, or where obscure abbreviations like mgr or svc are used without justification.

Quick Start

Review the provided code snippet for any inconsistent or unapproved abbreviations.