32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# GovOPlaN Records 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 Records 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 the GovOPlaN eAkte and institutional Records domain.
|
|
|
|
Records management for file plans, records classification, retention schedules, disposal holds, and archive handoff.
|
|
|
|
## Boundaries
|
|
|
|
- Depend on kernel contracts from `govoplan-core` and access contracts from `govoplan-access`.
|
|
- Keep domain behavior in this module; expose integration through manifests, capabilities, API routes, events, typed DTOs, and documentation topics.
|
|
- Do not import internals from sibling feature modules. Use optional dependencies and capabilities for cross-module behavior.
|
|
- Preserve exact source revisions and current source authorization at every filing boundary.
|
|
- Keep lifecycle and archive effects explicit, idempotent, recoverable, and separately governed.
|
|
|
|
## Local Workflow
|
|
|
|
Use Gitea issues as the canonical backlog and state log. The shared workflow is installed under `.gitea/`, with labels in `docs/gitea-labels.json`.
|
|
|
|
Focused verification:
|
|
|
|
```bash
|
|
PYTHONPATH=src /mnt/DATA/git/govoplan/.venv/bin/python -m unittest discover -s tests
|
|
```
|