Git Commits¶
Git Best Practices¶
1. Kleine, häufige Commits¶
- Ein Commit sollte möglichst eine kleine, abgeschlossenen Einheit sein.
- Jeder Commit sollte einen klar definierten Zweck erfüllen.
2. Aussagekräftige Commit-Messages¶
- Beschreiben was geändert wurde und warum.
- Siehe die Commit-Naming-Convention unten.
3. Branching¶
- Separate Branches für Features, Bugfixes oder Experimente.
- Beispiel: 'feature/new-login-page', 'bugfix/fix-login-error'.
Commit-Naming-Convention¶
Allgemeiner Aufbau¶
<type>: <title>: <description>
Commit-Typen¶
| Typ | Beschreibung |
|---|---|
| feat | Neues Feature |
| bug | Bugfix |
| refactor | Code-Refaktorierung |
| style | Änderungen an Code-Formatierung |
| docs | Änderungen an der Dokumentation |
| deploy | Änderungen an der Deployment-Logik |
| test | Hinzufügen oder Ändern von Tests |
| cleanup | Wartung/Aufräumen (keine Funktionsänderung) |
Beispiele¶
- feat: login: füge login stylesheet hinzu
- bug: register: fix email validation problem
- refactor: user-controller: vereinfache logic für user update
- style: css: formatiere abstände auf login seite
- docs: readme: überarbeite setup guide
- deploy: ci: füge neue umgebungsvariable für live hinzu
- test: api: füge tests hinzu
- cleanup: entferne ungenutzte grafiken
Tipps für Commit-Messages¶
Gute Commit-Message schreiben¶
- Klar und prägnant: Keine unnötigen Details.
- Im Präsens schreiben: Beispiel: "Fix broken API route" (nicht: "Fixed").
- Fokus auf "was" und "warum":
- Gut:
bug: user-auth: fix session timeout issue- Schlecht:fix bug
Commit-Habits¶
- Staging-Bereich prüfen: Stelle sicher, dass alle relevanten Dateien gestaged sind.
- Code testen: Vor jedem Commit sicherstellen, dass der Code funktioniert.
- Squash Commits: Bei kleinen Änderungen mehrere Commits zusammenfassen.