agentleFS
Sign inStart free
gaia-reactgaia-react/gaia/.claude/skills/naming-conventions/SKILL.md

naming-conventions

Skill26 starsChanged 7 days agoMITView on GitHub

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.

11 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 8 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Follow Apple's Swift API Design Guidelines: names should be clear at the point of use, reading like prose.

    line 8
  2. Very specific:

    Read references/examples.md for extended BAD/GOOD examples of each naming pattern.

    line 23

“Common” is measured: kept by at least 6 in 10 of the 8 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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 the typescript skill.

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.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free