bg_image
header

Conventional Commits

Conventional Commits sind ein einfacher Standard für Commit-Nachrichten in Git, der ein konsistentes Format für alle Commits vorschlägt. Dies erleichtert die Automatisierung von Aufgaben wie der Versionskontrolle (Versioning), der Changelog-Erstellung und der Rückverfolgung von Änderungen.

Das Format der Conventional Commits besteht aus einer speziellen Struktur der Commit-Nachricht, die typischerweise folgendermaßen aussieht:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Komponenten eines Conventional Commits:

  1. Type (Pflichtfeld): Beschreibt die Art der Änderung im Commit. Es gibt standardisierte Typen:

    • feat: Eine neue Funktion oder ein Feature.
    • fix: Eine Fehlerbehebung.
    • docs: Änderungen an der Dokumentation.
    • style: Änderungen am Code-Stil (z. B. Formatierung), die aber die Logik nicht beeinflussen.
    • refactor: Änderungen am Code, die weder Fehler beheben noch Funktionen hinzufügen, aber den Code verbessern.
    • test: Hinzufügen oder Ändern von Tests.
    • chore: Änderungen am Build-Prozess oder an Hilfswerkzeugen, die keinen Einfluss auf den Quellcode haben.
  2. Scope (optional): Beschreibt den betroffenen Teil des Codes oder der Anwendung, z. B. ein Modul oder eine Komponente.

    • Beispiel: fix(auth): corrected password hashing algorithm
  3. Description (Pflichtfeld): Eine kurze, prägnante Beschreibung der Änderung. Diese sollte in der Gegenwartsform formuliert sein (z. B. „add feature“ statt „added feature“).

  4. Body (optional): Eine ausführlichere Beschreibung der Änderung. Dies kann genutzt werden, um mehr Kontext oder technische Details anzugeben.

  5. Footer (optional): Hier können Hinweise zu Breaking Changes oder Referenzen zu Issues oder Tickets stehen.

    • Beispiel: BREAKING CHANGE: remove deprecated authentication method

Beispiel einer Commit-Nachricht im Conventional Commit-Format:

feat(parser): add ability to parse arrays

The parser now supports parsing arrays into lists.
This allows arrays to be passed as arguments to methods.

BREAKING CHANGE: Arrays are now parsed differently

Vorteile von Conventional Commits:

  • Konsistenz: Ein einheitliches Format für Commit-Nachrichten erleichtert es, den Projektverlauf zu verstehen.
  • Automatisierung: Tools können automatisch Versionen erzeugen, Changelogs erstellen und sogar Veröffentlichungen basierend auf Commit-Nachrichten vornehmen.
  • Rückverfolgbarkeit: Es wird leichter, den Zweck einer Änderung nachzuvollziehen, insbesondere bei Fehlerbehebungen oder neuen Funktionen.

Conventional Commits sind besonders in Projekten hilfreich, die SemVer (Semantic Versioning) verwenden, da sie es ermöglichen, automatisch neue Versionen basierend auf Commit-Typen zu erstellen.

 

 

 


Interactive Rebase

Ein Interactive Rebase ist eine erweiterte Funktion des Versionskontrollsystems Git, mit der du mehrere Commits in einem Branch überarbeiten, neu anordnen, zusammenführen oder löschen kannst. Im Gegensatz zu einem normalen Rebase, bei dem die Commits einfach auf einen neuen Basis-Commit „umgehängt“ werden, bietet ein interaktiver Rebase die Möglichkeit, jeden Commit in der Rebase-Reihe individuell zu bearbeiten.

Wann und warum wird ein Interactive Rebase verwendet?

  • Aufräumen der Commit-Historie: Vor dem Zusammenführen eines Branches in den Hauptzweig (z.B. main oder master) kannst du die Commit-Historie bereinigen, indem du unnötige Commits zusammenführst oder entfernst.
  • Reihenfolge ändern: Du kannst die Reihenfolge der Commits ändern, wenn sie in einer bestimmten Reihenfolge sinnvoller erscheinen.
  • Fixes zusammenfassen: Kleinere Fehlerkorrekturen, die nach einem Feature-Commit gemacht wurden, können mit dem ursprünglichen Commit zusammengeführt werden, um eine übersichtlichere und verständlichere Historie zu erstellen.
  • Commit-Messages bearbeiten: Du kannst die Commit-Nachrichten ändern, um klarere und aussagekräftigere Nachrichten zu hinterlassen.

Wie funktioniert ein Interactive Rebase?

Angenommen, du möchtest die letzten 4 Commits eines Branches bearbeiten, führst du folgendes Kommando aus:

git rebase -i HEAD~4

Ablauf:

1. Auswahl der Commits:

  • Nachdem du den Befehl eingegeben hast, öffnet sich ein Texteditor mit einer Liste der ausgewählten Commits. Jeder Commit ist mit dem Schlüsselwort pick markiert, gefolgt von der Commit-Nachricht.

Beispiel:

pick a1b2c3d Commit message 1
pick b2c3d4e Commit message 2
pick c3d4e5f Commit message 3
pick d4e5f6g Commit message 4

2. Bearbeiten der Commits:

  • Du kannst die pick-Befehle durch andere Schlüsselwörter ersetzen, um verschiedene Aktionen durchzuführen:
    • pick: Behalte den Commit unverändert.
    • reword: Ändere die Commit-Nachricht.
    • edit: Stoppt das Rebase, damit du Änderungen am Commit vornehmen kannst.
    • squash: Kombiniere den Commit mit dem vorherigen.
    • fixup: Kombiniere den Commit mit dem vorherigen, ohne die Commit-Nachricht zu behalten.
    • drop: Entferne den Commit.

Beispiel für eine bearbeitete Liste:

pick a1b2c3d Commit message 1
squash b2c3d4e Commit message 2
reword c3d4e5f New commit message 3
drop d4e5f6g Commit message 4

3. Speichern und Ausführen:

  • Nachdem du die Liste angepasst hast, speicherst du und schließt den Editor. Git führt dann die Rebase mit den angegebenen Aktionen durch.

4. Konflikte lösen:

  • Falls es während des Rebases zu Konflikten kommt, musst du diese manuell beheben und dann den Rebase-Prozess mit git rebase --continue fortsetzen.

Wichtige Hinweise:

  • Unterscheidung zwischen lokaler und gemeinsamer Historie: Interactive Rebase sollte in der Regel nur auf Commits angewendet werden, die noch nicht mit anderen geteilt wurden (z.B. auf einem Remote-Repository), da das Umschreiben der Historie nachteilige Auswirkungen auf andere Entwickler haben kann.
  • Sicherung: Es ist ratsam, vor einem Rebase eine Sicherung (z.B. durch einen temporären Branch) zu erstellen, um im Falle eines Fehlers zur ursprünglichen Historie zurückkehren zu können.

Zusammenfassung:

Interactive Rebase ist ein mächtiges Werkzeug in Git, das es ermöglicht, die Commit-Historie zu bereinigen, zu reorganisieren und zu optimieren. Es erfordert etwas Übung und Verständnis der Git-Konzepte, bietet aber eine große Flexibilität, um die Geschichte eines Projekts klar und nachvollziehbar zu gestalten.

 

 

 

 


Atomic Commit

Atomic Commits sind ein Konzept in Versionskontrollsystemen, das sicherstellt, dass alle Änderungen, die in einem Commit enthalten sind, vollständig und einheitlich angewendet werden. Das bedeutet, dass ein Commit entweder vollständig durchgeführt wird oder gar nicht – es gibt keinen Zwischenzustand. Diese Eigenschaft garantiert die Integrität des Repositories und verhindert Inkonsistenzen.

Wesentliche Merkmale und Vorteile von Atomic Commits sind:

  1. Konsistenz: Ein Commit wird nur dann gespeichert, wenn alle darin enthaltenen Änderungen erfolgreich sind. Dadurch wird sichergestellt, dass das Repository nach jedem Commit in einem konsistenten Zustand bleibt.

  2. Fehlervermeidung: Wenn ein Fehler auftritt (z.B. ein Netzwerkproblem oder ein Konflikt), wird der Commit abgebrochen und das Repository bleibt unverändert. Dies verhindert teilweise gespeicherte Änderungen, die zu Problemen führen könnten.

  3. Einheitliche Änderungen: Alle Dateien, die in einem Commit geändert werden, werden zusammen behandelt. Dies ist besonders wichtig, wenn Änderungen an mehreren Dateien logisch zusammenhängen und als Einheit betrachtet werden müssen.

  4. Rückverfolgbarkeit: Atomic Commits erleichtern die Rückverfolgbarkeit und das Debugging, da jede Änderung als kohärente Einheit nachvollzogen werden kann. Wenn ein Problem auftritt, kann es leicht zu einem bestimmten Commit zurückverfolgt werden.

  5. Einfache Rollbacks: Da ein Commit eine komplette Änderungseinheit darstellt, können unerwünschte Änderungen einfach rückgängig gemacht werden, indem auf einen vorherigen Zustand des Repositories zurückgesetzt wird.

In Subversion (SVN) und anderen Versionskontrollsystemen wie Git wird dieses Konzept implementiert, um die Qualität und Zuverlässigkeit der Codebasis zu gewährleisten. Atomic Commits sind besonders nützlich in kollaborativen Entwicklungsumgebungen, wo mehrere Entwickler gleichzeitig an verschiedenen Teilen des Projekts arbeiten.