Skip to content

CONTRIBUTING: document build_ui_dict.py and the UI projection #57

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
cloud3000 merged 1 commit into from
Jun 28, 2026
Merged

CONTRIBUTING: document build_ui_dict.py and the UI projection #57

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
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,30 @@ normalize.py # Phase 3: snake_case naming, entity/field aliases, cross-so
seeds/ # one module per source: each exposes CATEGORIES + ITEMS
tools/fetch_*.py # generators that (re)build seed modules from upstream
tools/gen_diagram.py, render_diagrams.py # diagrams
tools/build_ui_dict.py # derives ui_datadict.db (UI/governance projection)
tools/find.py, export_ddl.py # query by business term / emit CREATE TABLE
tools/ci_check.py # semantic invariant gate (datadict + ui_datadict)
sources.md # provenance + licenses (update when adding a source)
PROGRESS.md # running build log (add an entry per change)
```

## Derived: the UI projection (`ui_datadict.db`)

`tools/build_ui_dict.py` rebuilds `ui_datadict.db` + `ui_datadict.sql` from
`datadict.db` (read-only input) — a UI / resource-governance view
(`Categories → Groups → UI_DataItems`; see README → "UI projection"). It is
**fully derived**, so:

- **Never hand-edit `ui_datadict.db` / `ui_datadict.sql`** — change the data via
the seeds, rebuild `datadict.db`, then regenerate the projection.
- If your change alters `datadict.db`, **regenerate and commit** the projection:
```bash
python3 build_dict.py && python3 tools/build_ui_dict.py
```
- CI rebuilds and validates it (`tools/ci_check.py`: completeness vs datadict,
FK integrity, `ByteLength = CharLength*4`, positive `CharLength`, unique
`(GroupID, Name)`).

## Adding a new source

A "seed module" is any `seeds/<name>.py` exposing two lists:
Expand Down
Loading