Baseline standards: design, SOP, CI policy

This commit is contained in:
2025-12-20 15:17:15 +01:00
commit 769462c439
4 changed files with 632 additions and 0 deletions

96
README.md Normal file
View File

@ -0,0 +1,96 @@
# wlkns-dev-standards
## Zweck
Dieses Repository definiert **verbindliche Entwicklungs‑, Design‑ und CI‑Standards** für Software‑Projekte.
Es ist kein Projekt‑Template im engeren Sinn, sondern ein **Meta‑Repository**:
- Referenz
- Regelwerk
- Entscheidungsgrundlage
- Qualitätsmaßstab
Alles, was hier beschrieben ist, gilt als **Best Practice** und ist projektübergreifend anwendbar.
---
## Zielgruppe
- Einzelentwickler mit professionellem Anspruch
- kleine Teams
- Homelab‑ und Infrastruktur‑Projekte
- Open‑Source‑Projekte mit Fokus auf Wartbarkeit
Nicht Zielgruppe:
- Prototypen ohne Langzeitanspruch
- schnelle Wegwerf‑Skripte
- „Hauptsache läuft“-Setups
---
## Grundprinzipien
- **Klarheit vor Cleverness**
- **Reproduzierbarkeit vor Geschwindigkeit**
- **Ein erlaubter Weg statt vieler Optionen**
- **Explizite Regeln statt impliziter Annahmen**
Wenn ein Prozess nur funktioniert, weil man weiß, *wie er gemeint ist*, ist er falsch.
---
## Struktur des Repositories
```text
wlkns-dev-standards/
├─ design/ # Design‑System & UI‑Prinzipien
├─ sop/ # Standard Operating Procedures
├─ ci/ # CI‑Regeln & Gate‑Policies
├─ templates/ # Referenz‑ & Start‑Templates
├─ README.md
└─ CHANGELOG.md
```
Jeder Ordner ist thematisch abgeschlossen und unabhängig nutzbar.
---
## Nutzung
Dieses Repository wird **nicht eingebunden**, sondern **referenziert**.
Typische Nutzung:
- als Entscheidungsgrundlage bei neuen Projekten
- als Review‑Maßstab
- als Quelle für Templates
- als Dokumentation für Dritte
Empfohlen:
- relevante Dokumente im Projekt verlinken
- Templates kopieren, nicht verändern
---
## Versionierung
Änderungen an Regeln oder Standards werden:
- dokumentiert
- versioniert
- rückwirkend nachvollziehbar gehalten
Siehe: `CHANGELOG.md`
---
## Status
Aktueller Reifegrad: **aktiv in Entwicklung**
Inhalte gelten als stabil, sofern nicht explizit anders gekennzeichnet.
---
## Lizenz & Veröffentlichung
Das Repository ist derzeit **privat**, wird jedoch mit dem Anspruch gepflegt, jederzeit öffentlich nutzbar zu sein.
Keine Inhalte setzen interne Systeme, Namen oder proprietäre Werkzeuge voraus.