Repository governance
August 31, 2026 ยท View on GitHub
The FlagQuantum source repository is the product integration point. It is not the long-term store for raw profiler output, exploratory result matrices, or superseded research artifacts.
What belongs in the main repository
| Content | Canonical location | Retention rule |
|---|---|---|
| Product source | flagquantum/ | Versioned with the package. |
| Tests and reusable fixtures | tests/ | Keep fixtures minimal and deterministic. |
| User and maintainer documentation | docs/ | Current truth; archive superseded narratives outside reference docs. |
| Runnable examples | examples/ | Must use supported public APIs. |
| Benchmark runners and workloads | benchmarks/ | Keep maintained, reproducible entry points. |
| Machine-readable capability contracts | contracts/ | Stable filenames and schema versions. |
| Repository automation | tools/ | No runtime dependency on repository tools. |
| Curated evidence | benchmarks/results/{local,comparison,smoke,scalability}/ | Keep only evidence needed by a current claim, regression, or release gate. |
What does not belong
Store raw profiler traces, repeated experiment matrices, temporary cloud task payloads, intermediate plots, checkpoints, and superseded result sets in the team evidence store or a dedicated research/evidence repository. A retained summary should record provenance, hashes, reproduction commands, and the external archive identifier without claiming a stronger maturity level.
Evidence lifecycle
- A runner writes local or development output outside the promoted evidence set.
- The result is normalized and classified as local, comparison, smoke, or scalability evidence.
- Required provenance and release-gate checks are applied.
- Only the minimal result and supporting manifest needed for a current claim are committed.
- Superseded or bulky raw material is archived outside the source repository.
Historical benchmark families, provider batches, paper workspaces, task
fragments, and agent-specific authoring workflows are stored outside the source
repository. New compact, non-release artifact outputs use
artifacts/development/. An external migration must preserve any links used by
published documents and capability manifests by updating them atomically and
recording the source revision plus archive checksum.
The source repository must not add benchmarks/results/legacy/,
benchmarks/development/, benchmarks/research/, artifacts/legacy/, paper
submission workspaces, historical PR-readiness records, or project-specific
.codex/skills/ directories. Reusable workloads belong under
benchmarks/runners/; one-off analysis belongs in the external evidence
archive. Git history is a
recovery mechanism, not the long-term evidence store.
Review budget
Every change adding generated evidence should state:
- why the result must live in the source repository;
- its evidence class and retention period;
- the command and source revision used to create it;
- whether an existing result can be replaced instead of adding another copy.
Generated files larger than 1 MiB or result batches larger than 20 files should default to external storage unless a release or regression gate requires them.