From 17a86c87dc91fed12e7e02bfbc63db382324baa6 Mon Sep 17 00:00:00 2001 From: madgerm Date: Thu, 13 Nov 2025 02:00:02 +0100 Subject: [PATCH] alles toll --- .../Planung/Einleitung_und_Scope.md | 16 +++++++++++ .../Planung/Governance_und_Rollen.md | 28 +++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 00_Globale_Richtlinien/Planung/Einleitung_und_Scope.md create mode 100644 00_Globale_Richtlinien/Planung/Governance_und_Rollen.md diff --git a/00_Globale_Richtlinien/Planung/Einleitung_und_Scope.md b/00_Globale_Richtlinien/Planung/Einleitung_und_Scope.md new file mode 100644 index 0000000..052a351 --- /dev/null +++ b/00_Globale_Richtlinien/Planung/Einleitung_und_Scope.md @@ -0,0 +1,16 @@ +# Einleitung & Scope + +## Zweck +Der Ordner 00_Globale_Richtlinien definiert grundlegende, sofort geltende Regeln für die Code‑Basis: einheitlicher Code‑Style, klare Namenskonventionen und eine standardisierte Komponentenstruktur. Zusätzlich stellt er einen minimal lauffähigen Referenz‑Code bereit, um die Anwendung dieser Regeln zu demonstrieren. + +## Geltungsbereich +Diese Richtlinien sind verbindlich für alle Teilprojekte dieses Repositoriums. Erweiterte Themen (z. B. Security, Backup) werden in späteren Roadmap‑Kapiteln behandelt und sind nicht Teil dieses Dokuments. + +## Ordnerstruktur +- /Planung – Dokumente zu Style, Naming, Komponentenstruktur +- /Entworfener_Code – minimaler Referenz‑Code (z. B. FastAPI‑Gerüst) + +## Pflegehinweis +Änderungen an diesen Basisrichtlinien erfolgen ausschließlich über Pull‑Requests und ein Review durch die Maintainer. + +[Code Style](Code_Style.md) · [Namenskonventionen](Namenskonventionen.md) · [Komponenten-Standardstruktur](Komponenten_Standardstruktur.md) \ No newline at end of file diff --git a/00_Globale_Richtlinien/Planung/Governance_und_Rollen.md b/00_Globale_Richtlinien/Planung/Governance_und_Rollen.md new file mode 100644 index 0000000..ad750d3 --- /dev/null +++ b/00_Globale_Richtlinien/Planung/Governance_und_Rollen.md @@ -0,0 +1,28 @@ +# Governance & Rollen + +## Zweck +Definiert minimale Zuständigkeiten und Abläufe zur Pflege der globalen Baseline-Richtlinien und des Referenz-Codes. + +## Rollen +- Maintainer – verwalten Ordner, prüfen Pull-Requests, geben Releases frei. +- Contributor – schlagen Änderungen vor (PR). +- Reviewer – führen inhaltliche Qualitätskontrolle durch (kann Maintainer sein). +- CI-Bot – automatisiert Format-/Style-Checks (black, flake8, mypy). + +## Änderungsprozess +1. Fork → Branch → Änderung an Richtliniendokument oder Basis-Code. +2. Pull-Request mit kurzer Begründung (“Warum”) und Link auf betroffene Abschnitte. +3. Automatische Checks müssen grün sein. +4. Mindestens ein Reviewer + ein Maintainer-Approval vor Merge. +5. Merge per Squash-Commit in `main`. + +## Versionierung +- Änderungen an Richtlinien werden im Datei-Header mit Datumsangabe kommentiert. Beispiel: `Updated: 2025-11-13 – Kurze Notiz`. +- Semantische Tagging-Policy des Repos (`vMAJOR.MINOR`) spiegelt Breaking Changes (MAJOR) vs. Ergänzungen (MINOR) wider. + +## Konfliktlösung +- Streben nach Konsens. +- Bei Blockade: Maintainer entscheidet basierend auf Projektzielen. + +## Links +[Einleitung & Scope](Einleitung_und_Scope.md) · [Code Style](Code_Style.md) · [Namenskonventionen](Namenskonventionen.md) · [Komponenten-Standardstruktur](Komponenten_Standardstruktur.md) \ No newline at end of file