Initialize GovOPlaN module seed
This commit is contained in:
62
README.md
Normal file
62
README.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# GovOPlaN Consultation
|
||||
|
||||
`govoplan-consultation` is the GovOPlaN platform module seed for public consultations, hearings, stakeholder feedback, formal comments, response matrices, and publication of results.
|
||||
|
||||
This repository is initialized as a discoverable module seed. It exposes a module manifest, initial permissions, role templates, documentation metadata, Gitea workflow templates, and a focused manifest test. It intentionally does not yet add HTTP routes, database models, migrations, or WebUI navigation.
|
||||
|
||||
## Initial Ownership
|
||||
|
||||
- consultation processes
|
||||
- hearing events
|
||||
- stakeholder feedback
|
||||
- formal comments
|
||||
- response matrices
|
||||
- publication state
|
||||
|
||||
## Boundaries
|
||||
|
||||
This module does not own:
|
||||
|
||||
- portal account management
|
||||
- records retention policy
|
||||
- generic form definitions
|
||||
|
||||
Detailed boundary notes are in [docs/CONSULTATION_DOMAIN_BOUNDARY.md](docs/CONSULTATION_DOMAIN_BOUNDARY.md).
|
||||
|
||||
## Integrations
|
||||
|
||||
Expected optional integrations:
|
||||
|
||||
- portal
|
||||
- forms-runtime
|
||||
- files
|
||||
- records
|
||||
- transparency
|
||||
- reporting
|
||||
|
||||
## Development Install
|
||||
|
||||
From the core checkout:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -e ../govoplan-consultation
|
||||
```
|
||||
|
||||
Focused manifest verification:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-consultation
|
||||
PYTHONPATH=src:/mnt/DATA/git/govoplan-core/src /mnt/DATA/git/govoplan-core/.venv/bin/python -m unittest discover -s tests
|
||||
```
|
||||
|
||||
## Gitea Workflow
|
||||
|
||||
Issue templates are installed under `.gitea/`, and the shared label taxonomy is copied to `docs/gitea-labels.json` with the module label `module/consultation`.
|
||||
|
||||
From the core checkout, labels can be synced once a local `GITEA_TOKEN` is available:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./scripts/gitea-sync-labels.py --root /mnt/DATA/git/govoplan-consultation --apply
|
||||
```
|
||||
Reference in New Issue
Block a user