Steigern Sie Ihren Github-Ruf mit den richtigen Commit-Nachrichten

Eskere Guru

Anstatt einzeilige Git-Commit-Nachrichten mit der Option commit -m zu schreiben, erfahren Sie in diesem Artikel, wie Sie die richtigen Commit-Nachrichten schreiben. Eine ordnungsgemäße Festschreibung von Nachrichten ist wichtig, da andere genau sehen können, was Sie geändert haben, sodass andere Ihr Projekt leichter verfolgen können, um die Bekanntheit der Open Source-Community zu erhöhen.

Schreiben Sie eine richtige Commit-Nachricht

Öffnen Sie Ihren bevorzugten Texteditor in einer leeren Datei, anstatt die Festschreibungsnachricht in den Terminalbefehl aufzunehmen. Die Nachricht sollte dem folgenden Format entsprechen:

  • Die erste Zeile ist der Titel, der das gesamte Commit zusammenfasst.
  • Nach einer Leerzeile sollte die nächste Zeile oder mehrere Zeilen eine lesbare Beschreibung sein, die für das Festschreiben erforderlich ist. Dies kann so lange wie gewünscht sein.
  • Alle folgenden Zeilen sollten die genauen Änderungen am Code in einem solchen Format zusammenfassen:
    • Dateiname: Zeile # – Kurze Beschreibung der Änderung.

Beispiel für eine Commit-Nachricht

Unten sehen Sie eine Beispiel-Commit-Nachricht:

 
Added Docker support, new is_unique feature, plus bug fix.
 Added support for docker-compose and updated installation instruction as necessary. Also included a new feature within check_order() function to check for uniqueness, and fixed small bug when creating product slugs.
 src/somedir/library.py:381 -- Added 'is_unique' parameter to the check_order() function.
 src/products.py:194 -- Fixed bug when creating product slug.
 docker-compose.yml -- Added docker-compose file.
 docs/install.md -- Updated installation guide to include how to install via Docker.

Nachricht festschreiben

Wenn Sie jetzt ein Commit durchführen, verwenden Sie anstelle der Nachricht -m die Option –file . Wenn der Dateiname Ihrer Festschreibungsnachricht beispielsweise commit.txt lautet, führen Sie den folgenden Befehl aus:

 git commit --file commit.txt

Das ist alles dazu! Hoffentlich hilft dies Ihnen dabei, Ihren Followern standardisiertere und klarere Commit-Nachrichten bereitzustellen, Ihr Projekt bekannter zu machen und die Open Source- Community zu vergrößern.

Bildnachweis : Caleb White / Unsplash