alles toll
This commit is contained in:
16
00_Globale_Richtlinien/Planung/Einleitung_und_Scope.md
Normal file
16
00_Globale_Richtlinien/Planung/Einleitung_und_Scope.md
Normal file
@@ -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)
|
||||
28
00_Globale_Richtlinien/Planung/Governance_und_Rollen.md
Normal file
28
00_Globale_Richtlinien/Planung/Governance_und_Rollen.md
Normal file
@@ -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)
|
||||
Reference in New Issue
Block a user