Skip to content

docs: ADR 0003 — include-prefix short-form registry #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rxdu merged 1 commit into from
Jul 7, 2026
Merged

docs: ADR 0003 — include-prefix short-form registry #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/adr/0003-naming-and-branding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,17 @@ The **foundation owns the root namespace**: xmBase's shared vocabulary lives unq

Non-C++ components: **xmBoard** (KiCAD) has no code namespace; **xmFirmware** (Zephyr is C) uses a C identifier prefix `xm_…`.

**Include prefix (header install directory).** The default is `xm` + function word, matching the component (`xmbase/`, `xmdriver/`). Because the include prefix is typed in every consumer file, a long function word may register a short form — the registry is authoritative, one short form per component, decided at component creation:

| Component | Include prefix |
|---|---|
| xmBase | `xmbase/` |
| xmDriver | `xmdriver/` |
| xmNavigation | `xmnav/` |
| xmMessaging (planned) | `xmmsg/` |

Everything else keeps the full word: repository names, umbrella pin paths, C++ namespaces, CMake packages/targets, and package names never abbreviate.

### 5. Derivation test

The scheme is consistent iff all three artifacts derive mechanically from one function word:
Expand Down