Files
govoplan-facilities/AGENTS.md
T

1.5 KiB

GovOPlaN Facilities 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 Facilities 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 Facilities platform module seed.

Facilities management for buildings, rooms, maintenance, cleaning, keys, access zones, recurring inspections, occupancy, defects, and service contractors.

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.
  • Keep the seed non-invasive until runtime routes, persistence, and WebUI flows are intentionally designed.

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:

PYTHONPATH=src:/mnt/DATA/git/govoplan-core/src /mnt/DATA/git/govoplan-core/.venv/bin/python -m unittest discover -s tests