Ground Naming

Naming patterns. "Specific is better than generic."

attac-t cec8525 2 files · 8.7 KB Updated

File contents

Skill: Naming

"Names are the first documentation."

The Standard

  • Specific > Generic: Builder, Calculator over Manager, Handler, Service.
  • Verb + Noun: Actions CreateOrder, Jobs SendWelcomeEmail, Listeners NotifyAdmins.
  • Boolean Prefix: isValid, hasAccess, canEdit.
  • No Type Suffixes: Order not OrderEntity, User not UserContract.

The Check

Ask yourself:

  • Does the name explain what it does?
  • Does the name explain why it exists?
  • If you read the filename, do you know the contents?

Real-World Examples

See examples.md.

attac-t/the-foundry/tree/main/plugins/kernel/skills/ground-naming commit cec85251bd

Frequently asked questions

npx skillmds@latest add attac-t/ground-naming