naming-conventions
Applies descriptive, self-documenting naming in any language (TypeScript, bash, workflow YAML, Dockerfiles). Use this skill whenever naming or renaming an identifier, variable, constant, function, parameter, env var, workflow job, or Dockerfile ARG/ENV, or reviewing names for vag
Install
npx skills add https://github.com/gaia-harness/gaia/tree/main/.claude/skills/naming-conventions
claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install gaia-harness-gaia@llmmart
git clone https://github.com/gaia-harness/gaia.git
The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole gaia-harness/gaia collection as a plugin from our marketplace. Git is the plain clone.
Skill manifest
Naming Conventions
Follow Apple's Swift API Design Guidelines: names should be clear at the point of use, reading like prose. Favor long, descriptive names over short or abbreviated ones.
- Functions and methods: imperative verb phrases:
calculateProgressPercentageFromCompletedSets,processUserOnboardingProfile - Parameters: role, not type:
totalSecondsnotn,emailAddressnots - Variables: what they hold:
restDurationInSeconds,submitButton,weightInputValue - No abbreviations: owned by
.claude/rules/no-abbreviations.md - No type noise:
availableExercisesnotexerciseArray, and never so short it loses clarity
Casing is each language's own convention; for TypeScript, see .claude/rules/typescript.md.
Exception, React event handlers follow
handle{Action}{Element}from the react-code skill (e.g.handleClickSave,handleChangeInput), the{Element}is required, since a barehandleClickorhandleChangesays when it fires, not what it does. The descriptive naming guidelines above apply to utilities, hooks, callbacks, and non-event-handler functions.
Read references/examples.md for extended BAD/GOOD examples of each naming pattern.
Files (gaia)
-
references
-
examples.md 1.8 KB
Loading…
-
-
SKILL.md 1.6 KB
--- name: naming-conventions description: Applies descriptive, self-documenting naming in any language (TypeScript, bash, workflow YAML, Dockerfiles). Use this skill whenever naming or renaming an identifier, variable, constant, function, parameter, env var, workflow job, or Dockerfile ARG/ENV, or reviewing names for vagueness, abbreviations, or redundant type noise. --- # Naming Conventions Follow Apple's Swift API Design Guidelines: names should be clear at the point of use, reading like prose. Favor long, descriptive names over short or abbreviated ones. - **Functions and methods**: imperative verb phrases: `calculateProgressPercentageFromCompletedSets`, `processUserOnboardingProfile` - **Parameters**: role, not type: `totalSeconds` not `n`, `emailAddress` not `s` - **Variables**: what they hold: `restDurationInSeconds`, `submitButton`, `weightInputValue` - **No abbreviations**: owned by `.claude/rules/no-abbreviations.md` - **No type noise**: `availableExercises` not `exerciseArray`, and never so short it loses clarity Casing is each language's own convention; for TypeScript, see `.claude/rules/typescript.md`. > **Exception, React event handlers** follow `handle{Action}{Element}` from the react-code skill > (e.g. `handleClickSave`, `handleChangeInput`), the `{Element}` is required, since a bare > `handleClick` or `handleChange` says when it fires, not what it does. The descriptive > naming guidelines above apply to utilities, hooks, callbacks, and non-event-handler functions. Read `references/examples.md` for extended BAD/GOOD examples of each naming pattern.
Comments (0)
Sign in to join the conversation.
Reviews (0)
No reviews yet.
No comments yet.