Git Commits & Workflows
Für eine saubere Versionskontrolle in unseren Dokumentations- und Automatisierungsprojekten folgen wir dem "Conventional Commits" Standard. Das macht die Historie lesbar und nachvollziehbar.
1. Der Basis-Workflow im Terminal
Wenn du Dateien lokal (z. B. in VS Code) bearbeitest, läuft der Standardprozess wie folgt ab:
# 1. Änderungen zum Staging hinzufügen
git add .
# 2. Änderungen protokollieren (Commit erstellen)
git commit -m "docs: füge neue Anleitung für WSL2 hinzu"
# 3. Änderungen auf GitHub hochladen (triggert den Cloudflare Build)
git push origin main
2. Conventional Commits Namenskonvention
Ein Commit-Titel sollte immer verraten, was genau gemacht wurde. Wir nutzen folgende Präfixe:
- docs: Änderungen an der Dokumentation (HTML-Dateien, Markdown).
- feat: Ein neues Feature oder eine komplett neue Anleitung (z. B.
feat: NAS Docker Compose Setup). - fix: Behebung eines Fehlers (z. B. kaputter Link oder Schreibfehler).
- style: Änderungen am CSS-Design (z. B.
style: update info-box colors). - chore: Wartungsarbeiten, die den Nutzer nicht betreffen (z. B. Updates im Build-Skript
build.py).
Warum das wichtig ist: Wenn das Cloudflare Deployment einmal fehlschlägt, kannst du in der Git-Historie sofort sehen, welcher Commit (z. B. "docs: update index") den Fehler verursacht hat und diesen gezielt rückgängig machen.