Skip to content
DispatchAtlas
Search

Repository Hygiene

DispatchAtlas repository hygiene — what source control tracks, what stays private, and the gates that keep generated outputs, caches, and credentials out of Git.

DispatchAtlas source control contains hand-authored source, tests, configuration, documentation, and reproducible metadata. Local execution products stay outside Git unless a policy explicitly promotes them to source.

🧹 Generated Output Policy

Generated experiment data, checkpoints, result bundles, coverage reports, docs build output, package artifacts, and release candidates are ignored by default. They are regenerated from source and recorded through provenance when later gates promote them.

Tracked generated files require:

  • A source owner.
  • A regeneration command.
  • A retention rationale.
  • A review path for stale output.

🗃️ Cache Policy

Local caches from Python, Ruff, mypy, pytest, coverage, documentation builds, and virtual environments are ignored. CI may cache dependencies, but cache keys must derive from lockfiles and workflow inputs.

🔬 Local Experiment Output Policy

Local experiment runs write to the experiments workspace's ignored output layers — run results, logs, checkpoints, and evidence bundles, as laid out in the workspace's own README — alongside other ignored scratch locations such as outputs/ or artifacts/. Final research evidence is produced through validated campaign and analysis commands before any public use.

📋 Artifact Retention Rules

Artifact classDefault locationGit statusRetention
Package buildsdist/IgnoredRebuild on demand.
Docs buildsite/out/IgnoredRebuild on demand.
Coveragehtmlcov/, .coverage*IgnoredRebuild during quality checks.
Smoke outputsoutputs/IgnoredKeep locally only when debugging.
Campaign resultsthe experiments workspace's results and checkpoint layersIgnoredPromote only through provenance-gated exports.
Release evidenceartifacts/Ignored until approvedRetain by release-candidate policy.