pokebuddy/docs/NAMING_GUIDELINES.md
2026-04-25 23:14:38 -03:00

48 lines
915 B
Markdown

# Naming Guidelines
Companion names should be short, original and developer-flavored.
## Good patterns
Blend a technical concept with a creature, object or vibe:
- `Zap` + `bit` → Zapbit
- `Diskette` + `x` → Diskettex
- `Null` + `Wisp` → NullWisp
- `Prompt` + `Moth` → PromptMoth
- `Cache` + `Goblin` → CacheGoblin
- `Merge` + `Drake` → MergeDrake
## Good names
- LintFox
- CronCrab
- TokenBat
- EnvImp
- JsonGecko
- ApiOtter
- DockerMole
- Shellfin
- ForkSprite
- BugSlug
## Avoid
Avoid names that are:
- direct references to third-party characters;
- modified versions of third-party character names;
- too close to protected brands;
- hard to pronounce;
- too generic.
## Test
Ask:
1. Is this name searchable?
2. Does it evoke a dev concept?
3. Would it still work without any outside reference?
4. Could a contributor draw it without copying anything?
If yes, it probably belongs here.