Skip to content

Governance and Operations

James Daley edited this page Jun 20, 2026 · 2 revisions

Governance And Operations

Governance in this repository exists to keep runtime behavior, public contracts, documentation, and validation evidence aligned.

Repository Evidence Surfaces

Surface Purpose
README.md Primary repository orientation.
CHANGELOG.md Notable release and change history.
CONTRIBUTING.md Contributor workflow and validation expectations.
wiki.md Repository-tracked index of this Wiki page set.
docs/governance Discussion automation and moderation policy.
implementation-policy.json Machine-readable coding policy and invariants.
framework-policy.json Machine-readable framework architecture and API summary.
.forsetti/alignment Runtime-boundary alignment reports and native-validation blockers.

Pull Request Workflow

flowchart TD
    Branch["create focused branch"]
    Change["make scoped changes"]
    Docs["update docs and changelog when needed"]
    Local["run available local validation"]
    Review["open pull request"]
    Remote["repository surface workflow"]
    Merge["owner review and merge"]

    Branch --> Change --> Docs --> Local --> Review --> Remote --> Merge
Loading

The local Windows/MSVC wrapper remains the native build/test source of truth until full remote build/test parity is restored.

Discussion Automation

Discussion automation is repository-grounded:

flowchart LR
    Discussion["GitHub Discussion"]
    Router["topic router"]
    Sources["repository sources\nREADME, Wiki, docs, code, tests"]
    Response["file-grounded response"]
    Fallback["fallback message"]

    Discussion --> Router
    Router --> Sources
    Sources --> Response
    Sources --> Fallback
Loading

The current repository scripts are:

Script Purpose
Scripts/github/discussion_router.py Routes discussions to source-grounded response profiles.
Scripts/github/discussion_moderator.py Applies code-of-conduct and moderation policy checks.
Scripts/github/discussion_topic_seeder.py Seeds discussion topics from current repository documents.

Configuration lives in:

  • .github/discussion-automation.json
  • .github/discussion_moderation_policy.json
  • .github/discussion_topic_generator.json

Responses are limited to repository-tracked sources. Keeping this Wiki current improves response quality.

Discussion Topic Seeding

The topic seeder derives suggested discussion topics from repository truth. It should:

  • Read current docs and governance sources.
  • Avoid duplicate seeded topics.
  • Limit the number of new topics per run.
  • Point topic bodies back to source paths.

Moderation

The moderation workflow applies the repository code of conduct and discussion moderation policy. It removes clearly disallowed discussion content and records incidents for maintainer review.

Evidence Policy

Evidence should be concrete, local, and reproducible:

  • Command run.
  • Pass/fail/deferred result.
  • Why a command could not run, if applicable.
  • Files changed.
  • Tests added or rerun.
  • Remaining risks.
  • Owner decision points.

Runtime-boundary alignment evidence is under .forsetti/alignment. The final alignment report remains blocked until native Debug/Release builds, CTest, the PowerShell guardrail wrapper, MSVC, and vcpkg validation pass on Windows.

Documentation Operations

When behavior changes:

  1. Update source comments only where the code would otherwise be hard to understand.
  2. Update README for onboarding and status changes.
  3. Update Wiki pages for detailed architectural or operational explanations.
  4. Update CHANGELOG.md for notable changes.
  5. Update governance docs when automation or policy changes.
  6. Run guardrails and repository surface scans before publishing.

Clone this wiki locally