Skip to content

Tighten naming conventions wording #1297

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

Draft
JeroenDeDauw wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Tighten naming conventions wording #1297

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
8 changes: 3 additions & 5 deletions docs/naming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,12 @@ A UI component never shares its name with a data-access interface.

## "Store"

Always qualify which store is meant:
Always qualify which store is meant, in identifiers, docs, and discussion:

- **Pinia store** — a frontend state store, e.g. `SubjectStore`
([ADR 30](adr/030-frontend-store-registry-semantics.md)).
- **Graph Store** — a configured projection target ([Glossary](glossary.md)).
- A concrete technology name ("SPARQL store", "triple store") only when the statement is about that technology.

Bare "store" is ambiguous across these three; write the qualified form in identifiers, docs, and discussion.
- **Technology name** — "SPARQL store", "triple store", used only when the statement is about that technology.

## Registry

Expand All @@ -42,7 +40,7 @@ Components are named noun-first with a role suffix:
- `<X>Picker` — selects an existing X.
- `<X>Dialog` — a modal container; combined as `<X><Role>Dialog` (e.g. `SubjectCreatorDialog`).

## Known collisions, unresolved
## Known unresolved collisions

Do not add new uses of these names until the linked decision lands:

Expand Down