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

Anstatt einzeilige Git-Commit-Nachrichten mit dem zu schreiben Commit -m In diesem Artikel erfahren Sie, wie Sie die richtigen Commit-Nachrichten schreiben. Eine ordnungsgemäße Festschreibungsnachricht ist wichtig, damit andere genau sehen können, was Sie geändert haben. Erleichtern Sie anderen die Verfolgung Ihres Projekts, um die Bekanntheit von Open Source zu erhöhen Gemeinschaft.

Schreiben Sie eine richtige Commit-Nachricht

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

• Die erste Zeile ist der Titel, der das gesamte Commit zusammenfasst.
instagram viewer
• 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:

Docker-Unterstützung, neue Funktion is_unique sowie Fehlerbehebung hinzugefügt.
Unterstützung für Docker-Compose hinzugefügt und Installationsanweisungen nach Bedarf aktualisiert. Außerdem wurde eine neue Funktion in die Funktion check_order () aufgenommen, um die Eindeutigkeit zu überprüfen, und ein kleiner Fehler beim Erstellen von Produkt-Slugs behoben.
src / somedir / library.py: 381 - Der Funktion check_order () wurde der Parameter 'is_unique' hinzugefügt.
src / products.py: 194 - Fehler beim Erstellen des Produkt-Slugs behoben.
docker-compose.yml - Docker-compose-Datei hinzugefügt.
docs / install.md - Die Installationsanleitung wurde aktualisiert und enthält nun Informationen zur Installation über Docker.

Nachricht festschreiben

Wenn Sie jetzt ein Commit durchführen, anstatt das zu verwenden -m Nachricht, verwenden Sie die--Datei Möglichkeit. Wenn der Dateiname Ihrer Commit-Nachricht beispielsweise commit.txt lautet, führen Sie den folgenden Befehl aus:

git commit --file commit.txt

Das ist alles dazu! Hoffentlich hilft Ihnen dies dabei, Ihren Followern standardisiertere und klarere Commit-Nachrichten zu liefern, Ihrem Projekt zu helfen, Bekanntheit zu erlangen, und dem zu helfen Open Source Gemeinschaft wachsen.

Bildnachweis: Caleb White /Unsplash