Zum Inhalt springen
DispatchAtlas
Suchen

Repository-Hygiene

Die Versionskontrolle von DispatchAtlas enthält handverfasste Quelle, Tests, Konfiguration, Dokumentation, und reproduzierbare Metadaten. Lokale Ausführungsprodukte bleiben außerhalb von Git, sofern eine Richtlinie sie nicht ausdrücklich zu Quelle erhebt.

🧹 Richtlinie für generierte Ausgaben

Generierte Experimentdaten, Prüfpunkte, Ergebnispakete, Coverage-Berichte, Docs-Build-Ausgabe, Paket-Artefakte, und Release-Kandidaten werden standardmäßig ignoriert. Sie werden aus der Quelle regeneriert und über Provenienz aufgezeichnet, wenn spätere Gates sie befördern.

Verfolgte generierte Dateien erfordern:

  • Einen Quell-Eigentümer.
  • Einen Regenerationsbefehl.
  • Eine Aufbewahrungsbegründung.
  • Einen Prüfpfad für veraltete Ausgaben.

🗃️ Cache-Richtlinie

Lokale Caches von Python, Ruff, mypy, pytest, Coverage, Dokumentations-Builds, und virtuellen Umgebungen werden ignoriert. CI darf Abhängigkeiten cachen, aber Cache-Schlüssel müssen aus Lockfiles und Workflow-Eingaben abgeleitet werden.

🔬 Richtlinie für lokale Experiment-Ausgaben

Lokale Experimentläufe schreiben in die ignorierten Ausgabeschichten des Experimente-Arbeitsbereichs — Laufergebnisse, Logs, Prüfpunkte, und Belegpakete, wie im README des Arbeitsbereichs selbst angeordnet — neben anderen ignorierten Scratch-Orten wie outputs/ oder artifacts/. Endgültige Forschungsbelege werden vor jeder öffentlichen Nutzung über validierte Kampagnen- und Analysebefehle erzeugt.

📋 Regeln zur Artefakt-Aufbewahrung

ArtefaktklasseStandardortGit-StatusAufbewahrung
Paket-Buildsdist/IgnoriertBei Bedarf neu bauen.
Docs-Buildsite/out/IgnoriertBei Bedarf neu bauen.
Coveragehtmlcov/, .coverage*IgnoriertWährend der Qualitätsprüfungen neu bauen.
Smoke-Ausgabenoutputs/IgnoriertNur beim Debuggen lokal behalten.
Kampagnen-Ergebnissedie Ergebnis- und Prüfpunktschichten des Experimente-ArbeitsbereichsIgnoriertNur über provenienzgesperrte Exporte befördern.
Release-Belegeartifacts/Ignoriert bis genehmigtGemäß Release-Kandidaten-Richtlinie aufbewahren.