naming-cheatsheet

Enforce A/HC/LC and S-I-D naming conventions for variables, functions, and classes.

Updated Nov 28, 2025
One-click install
npx skills add https://github.com/davidsteinberger/dotfiles --skill naming-cheatsheet-davidsteinberger
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: naming-cheatsheet
Source: https://github.com/davidsteinberger/dotfiles/tree/main/opencode/.config/opencode/skills/naming-cheatsheet
Command: npx skills add https://github.com/davidsteinberger/dotfiles --skill naming-cheatsheet-davidsteinberger

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the common challenge of inconsistent and unclear naming conventions in code, which can lead to confusion, bugs, and slower development cycles.

Core Features & Use Cases

  • Language-Agnostic Naming: Provides a universal pattern (A/HC/LC) applicable across all programming languages.
  • Principle-Based Guidelines: Emphasizes Short, Intuitive, and Descriptive (S-I-D) naming.
  • Action & Prefix Definitions: Clearly defines common actions (get, set, reset, remove, delete, compose, handle) and boolean/boundary prefixes (is, has, should, min, max, prev, next).
  • Use Case: When naming a new function that retrieves user data, you can use getUser or getUserProfile based on the context, ensuring clarity and adherence to best practices.

Quick Start

Apply the A/HC/LC naming pattern to name a new variable that stores the user's authentication status.

Frequently Asked Questions about naming-cheatsheet

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

FAQPage Schema
What is the A/HC/LC pattern for code naming conventions?

The A/HC/LC pattern is a language-agnostic structure for naming functions and variables, combining Action, Host, and Context elements to enforce consistent code style and readability across programming languages.

How do I name boolean variables and boundary conditions in my code?

Apply prefixes like is, has, and should for boolean states, and use min, max, prev, or next for boundary conditions to make variable intent clear during code reviews.

What's the best way to name functions for common actions like retrieving or deleting data?

Use predefined action verbs like get, set, reset, remove, delete, compose, or handle to describe function operations, adhering to programming best practices and improving developer productivity.

Can I apply these naming conventions across different programming languages?

Yes, the guidelines are language-agnostic, utilizing the S-I-D principles of Short, Intuitive, and Descriptive to maintain consistent code style across different programming languages.

How do I ensure my variable names are both short and descriptive during refactoring?

Follow the S-I-D principles, making names Short to reduce visual noise, Intuitive for immediate understanding, and Descriptive enough to not require context, facilitating smoother code refactoring.