3002833
/
Git
2
8
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Git/Extras/Commit_Message_Guide.md

1.6 KiB
Raw Blame History

Anleitung für Commit Nachrichten

Format

Die Commit-Nachricht sollte im Präsens sein und das folgende Format haben:

<type>: <message>
  • <type> beschreibt die Art der Änderung.
  • <message> ist eine kurze und prägnante Beschreibung der Änderung.

Beispiel

chore: Update README.md
^---^  ^--------------^
|      |
|      +-> Beschreibung im Present Tense.
|
+-------> Type: chore, docs, feat, fix, refactor, oder test.

Wichtige Commit-Typen

  • feat: Hinzufügen neuer Funktionen oder Erweiterungen.
  • fix: Behebung eines Fehlers oder Problems.
  • docs: Dokumentation: Änderungen an der Dokumentation, sei es im Code oder außerhalb.
  • refactor: Umstrukturierung des Codes ohne Änderung der Logik.
  • test: Änderungen an Tests, insbesondere wenn neue Tests hinzugefügt oder bestehende geändert werden.
  • chore: Wartungsaufgaben, Aktualisieren von Abhängigkeiten, Anpassungen an Build-Skripten, etc

Zusätzliche Hinweise

  • Präsens und Englisch: Verwende immer das Präsens (Present Tense) und schreibe die Commit-Nachricht auf Englisch. Zum Beispiel „Add“ statt „Added“ und „Fix“ statt „Fixed“.
  • Klarheit: Halte die Commit-Nachricht so kurz und präzise wie möglich. Der Leser sollte verstehen können, was geändert wurde, ohne den Code selbst zu durchsuchen.
  • Imperativ: Verwende immer die Befehlsform (z.B. „Add“, „Fix“, „Update“).
  • Kein Übermaß an Details: Wenn du mehr Informationen benötigst, können diese im Body des Commits (falls nötig) oder in einem separaten Task- oder Issue-Tracker angegeben werden.