SKILL.md
Naming Cheatsheet
Use names that are short, intuitive, and descriptive.
Goal
Make code read naturally. Reduce ambiguity. Keep names consistent.
Rules
- Use English.
- Follow project convention.
- Avoid contractions and made-up words.
- Avoid duplicated context.
- Match singular/plural to value shape.
- Name booleans by expected truth.
- Reserve React
use prefix for hooks.
Function Pattern
prefix? + action + high context + low context?
Examples:
getUser
getUserMessages
handleClickOutside
shouldDisplayMessage
Actions
get: read or fetch data.
set: assign next value.
reset: restore initial state.
add / remove: collection changes.
create / delete: entity lifecycle.
compose / build: create value from values.
handle: respond to event.
Boolean Prefixes
is: state, like isActive.
has: possession, like hasItems.
should: condition plus action, like shouldRender.
can: capability, like canEdit.
// Bad
const isProductsExist = products.length > 0
// Good
const hasProducts = products.length > 0
React and Errors
- Use
useX only for hooks.
- Event handlers:
handleX.
- Props callbacks:
onX.
- Factory functions need verbs:
createErrorResult.
error: Error instance.
errorMessage: string.
errors: list.
Output
## Naming Review
Identifier: [current name]
Issue: [unclear / inconsistent / too broad / wrong shape]
Better name: [new name]
Reason: [why]
Pattern: [action/context/boolean/boundary]