Git Workflow
Git dient als zentrale Versionsverwaltung der Platrona-Plattform.
Ein strukturierter Workflow stellt sicher, dass Änderungen nachvollziehbar bleiben und die Codebasis langfristig stabil entwickelt werden kann.
Grundprinzip
Jede Änderung am Projekt sollte:
- nachvollziehbar
- dokumentiert
- reproduzierbar
sein.
Branches
Aktuell erfolgt die Entwicklung überwiegend auf einem Hauptentwicklungszweig.
Mit wachsendem Projektumfang kann die Branch-Struktur erweitert werden.
Geplante Branches:
main
develop
feature/*
hotfix/*
release/*
Commits
Commits sollen möglichst klein und thematisch klar getrennt sein.
Jeder Commit sollte genau eine zusammenhängende Änderung enthalten.
Gute Commit-Nachrichten
✅ Beispiele
Add email verification endpoint
Improve session management
Fix refresh token validation
Update launcher API
❌ Weniger hilfreiche Beispiele
Update
Fix
Test
123
Pull Requests
Vor dem Zusammenführen größerer Änderungen sollte geprüft werden:
- Funktioniert die Änderung?
- Ist der Code verständlich?
- Wurde die Dokumentation angepasst?
- Entspricht der Code den Coding Guidelines?
Code Reviews
Größere Änderungen sollten möglichst von einer zweiten Person überprüft werden.
Dadurch können Fehler frühzeitig erkannt und Verbesserungen diskutiert werden.
Versionierung
Neue Versionen werden veröffentlicht, sobald ein definierter Entwicklungsabschnitt abgeschlossen wurde.
Die Versionsnummern folgen einem nachvollziehbaren Entwicklungsprozess.
Grundsatz
Git dokumentiert die Entwicklungsgeschichte von Platrona.
Eine saubere Commit-Historie erleichtert spätere Fehleranalysen und die langfristige Wartung.
Aktueller Entwicklungsstand
Platrona befindet sich derzeit in einer frühen Entwicklungsphase.
Die Entwicklung erfolgt aktuell hauptsächlich durch die Projektleitung.
Mit zunehmender Größe des Projekts werden Git-Workflows, Feature-Branches und Code-Reviews schrittweise eingeführt.
Hinweis
Die aktuell beschriebenen Richtlinien bilden den Zielzustand für die Entwicklung von Platrona.
Einige Prozesse werden bereits verwendet, andere werden mit dem Wachstum des Projekts schrittweise eingeführt.
Jeder Commit ist ein Teil der Geschichte von Platrona.