29 lines
1.3 KiB
Markdown
29 lines
1.3 KiB
Markdown
# GovOPlaN Dataflow Codex Guide
|
|
|
|
## Documentation Contract
|
|
|
|
- Treat documentation as part of every behavior change. Update this module's manifest-driven `DocumentationTopic` contributions for affected user and administrator behavior.
|
|
- Keep feature content here; `govoplan-docs` projects it without importing Dataflow internals.
|
|
- Maintain a static user/admin baseline and run `/mnt/DATA/git/govoplan/tools/checks/check-manifest-shapes.py` after behavior or manifest changes.
|
|
|
|
## Scope
|
|
|
|
This repository owns canonical pipeline definitions, immutable revisions,
|
|
validation, constrained SQL compilation, preview and run diagnostics, and
|
|
lineage references.
|
|
|
|
Keep external connection profiles and credentials in `govoplan-connectors`,
|
|
analytical presentation in `govoplan-reporting`, process orchestration in
|
|
`govoplan-workflow`, and sanctions review semantics in
|
|
`govoplan-risk-compliance`.
|
|
|
|
## Working Rules
|
|
|
|
- Never pass user-entered SQL directly to a database.
|
|
- Keep previews bounded by rows, bytes, nodes, and execution time.
|
|
- Do not persist preview row contents unless a future explicit retention policy
|
|
requires it.
|
|
- Optional module integrations use manifest interfaces and capabilities, not
|
|
direct imports.
|
|
- Gitea issues are the canonical backlog and implementation state.
|