naming

Topics in the source

• Names and language
• The boundary is who reads it
• Casing
• Records are addressed by their stable id
• Commits
• Before a bulk rename

Identifiers, file names, routes, comments and commit messages are in English: their readers are developers and tools. Everything a person reads on screen, in an e-mail or in a notification is in that person's language. The line is the audience, not "string or not string". Renaming by search-and-replace cannot see that line. Replacing search across a codebase once turned aria-label="Limpar busca" into aria-label="Limpar search". After any rename, search for mixed-language phrases in user-facing text. | Kind | Style | Example | |---|---|---| | Variable, function, JSON field | camelCase | userId, loadPosts() | | Class, component | PascalCase | PostEditor | | Module constant | SCREAMINGSNAKE | MAXRETRIES | | File | kebab-case | post-editor.js | | Route segment | kebab-case, English | /posts/{id}/edit | Id, never ID: userId, getById. Booleans ask a yes/no question and are affirmative: isOpen, hasAccess, canEdit, shouldRetry. Never notReady or disabled as a boolean name. Routes, API paths, webhooks and public links use the record's UUID: /posts/0b5c…/edit, never /post/12. A per-account counter is a display label. A slug the customer chooses is fine for public pages. Conventional Commits:

This is an excerpt. Refer to the complete source and its current requirements.