Commit-Nachrichtenleitfaden

Commit-Nachrichten

Eindeutige Commit-Nachrichten erleichtern das Prüfen von Pull-Anfragen und das Generieren von Versionshinweisen. Das Blockly-Projekt nutzt dazu konventionelle Commits.

Jeder Commit sollte folgendes Format haben:

<type>: <description>

[optional body]

[optional footer(s)]

Beachten Sie, dass das zentrale Blockly-Repository einen Commit-Linter hat, um dies zu erzwingen. Wenn Ihre Pull-Anfrage mehrere Commits hat, prüft der Linter den Titel. Wenn ein einzelnes Commit vorhanden ist, wird dieses Commit geprüft. Am besten ist es, wenn sowohl Ihre einzelnen Commits als auch der Titel der Pull-Anfrage diesen Richtlinien entsprechen.

Typ

Der Typ darf nicht leer sein und darf nur Kleinbuchstaben enthalten. Im Folgenden finden Sie eine Liste der zulässigen Typen.

Hausarbeit
Für Commits, die routinemäßige/automatisierte Aufgaben wie das Aktualisieren von Abhängigkeiten ausführen.
einstellen
Für Commits, bei denen Funktionen eingestellt wurden.
feat
Für Commits, die Blockly um neue Funktionen ergänzen.
fix
Für Commits, die Programmfehler/Fehler in Blockly beheben.
Release
Für Commits im Zusammenhang mit der Veröffentlichung einer neuen Version.

Nicht abwärtskompatible Änderungen

Commits, die funktionsgefährdende Änderungen vornehmen, sollten nach dem Typ des Commits einen ! anhängen. Nicht funktionsgefährdende Änderungen sind Änderungen, die Entwickler, die Blockly in ihren Apps verwenden, beeinträchtigen können, sodass sie zusätzlichen Aufwand erfordern.

Beispiel: fix!: return type of workspace.paste

Wichtige Änderungen können jeden der oben genannten gültigen Typen enthalten.

Beschreibung

Die Beschreibung darf nicht leer sein und darf maximal 256 Zeichen lang sein.

Text

Der Text ist optional. Wenn sie angegeben wird, sollte zwischen ihr und der Beschreibung eine leere Zeile stehen. Er darf in Zeilen mit maximal 256 Zeichen unterteilt werden.

Normalerweise empfiehlt es sich, diese Art von Informationen nicht direkt im Commit, sondern in die Beschreibung der Pull-Anfrage aufzunehmen.

Die Fußzeile ist optional. Falls angegeben, sollte zwischen ihr und dem Text eine Leerzeile stehen. Er darf in Zeilen mit maximal 256 Zeichen unterteilt werden.

Unkonventionelle Commits beheben

Wenn Sie bei Ihren Änderungen keine konventionellen Commits verwendet haben, gibt es zwei Möglichkeiten, die Nachrichten zu korrigieren, je nachdem, wie viele Commits Sie haben:

  1. Wenn Ihre Pull-Anfrage mehrere Commits enthält, bearbeiten Sie den Titel der Pull-Anfrage, um die Anforderungen zu erfüllen. Wenn die Pull-Anfrage zusammengeführt wird, werden die anderen Commits zusammengedrückt, sodass aus dem Titel die Commit-Nachricht wird.

  2. Wenn Ihre Pull-Anfrage einen einzelnen Commit enthält, ändern Sie die Commit-Nachricht mit git commit --amend und erzwingen Sie dann die Übertragung Ihrer Änderungen an die Verzweigung von Blockly. Dadurch werden automatisch alle offenen Pull-Anfragen aktualisiert, die mit diesem Zweig verknüpft sind. git push --force origin my-branch.