Leitfaden für Commit-Nachrichten

Commit-Nachrichten

Durch aussagekräftige Commit-Nachrichten lassen sich Pull-Anfragen leichter überprüfen und Release-Hinweise einfacher generieren. Im Blockly-Projekt werden konventionelle Commits verwendet, um dies zu erleichtern.

Jedes Commit sollte das folgende Format haben:

<type>: <description>

[optional body]

[optional footer(s)]

Das Haupt-Blockly-Repository enthält einen Commit-Linter, der dabei hilft, diese Vorgaben einzuhalten. Wenn Ihre Pull-Anfrage mehrere Commits enthält, wird der Titel vom Linter geprüft. Wenn es nur einen Commit gibt, wird dieser geprüft. Am besten halten Sie sich sowohl bei Ihren einzelnen Commits als auch beim Titel des Pull-Requests an diese Richtlinien.

Typ

Der Typ darf nicht leer sein und muss nur Kleinbuchstaben enthalten. Im Folgenden finden Sie eine Liste der akzeptierten Typen.

  • chore:Für Commits, mit denen Routine-/automatisierte Aufgaben wie das Aktualisieren von Abhängigkeiten abgeschlossen werden.

  • deprecate:Für Commits, die Funktionen einstellen.

  • feat:Für Commits, die Blockly neue Funktionen hinzufügen.

  • fix:Für Commits, mit denen Fehler in Blockly behoben werden.

  • release:Für Commits, die sich auf die Veröffentlichung einer neuen Version beziehen.

Wichtige Änderungen

Bei Commits, die wichtige Änderungen enthalten, sollte nach dem Typ des Commits ein ! angehängt werden. Breaking Changes sind Änderungen, die dazu führen können, dass Entwickler, die Blockly in ihren Apps verwenden, zusätzliche Arbeit haben.

Beispiel: none fix!: return type of workspace.paste

Abwärtskompatibilitätsprobleme können einen der oben genannten gültigen Typen haben.

Beschreibung

Die Beschreibung darf nicht leer sein und muss weniger als 256 Zeichen enthalten.

Text

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

Normalerweise ist es ratsam, diese Art von Informationen in die Beschreibung des Pull-Requests aufzunehmen und nicht direkt in den Commit.

Die Fußzeile ist optional. Wenn sie angegeben wird, sollte zwischen ihr und dem Text eine leere Zeile stehen. Er muss in Zeilen mit maximal 256 Zeichen unterteilt werden.

Nicht konventionelle Commits korrigieren

Wenn Sie bei Ihren Änderungen keine Conventional 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, damit er den Anforderungen entspricht. Wenn der Pull-Request zusammengeführt wird, werden Ihre anderen Commits zusammengefasst, sodass der Titel zur Commit-Nachricht wird.

  2. Wenn Ihre Pull-Anfrage nur ein Commit enthält, ändern Sie die Commit-Nachricht mit git commit --amend und erzwingen Sie dann das Pushen Ihrer Änderungen in Ihren Fork von Blockly. Dadurch werden alle offenen Pull-Anfragen, die mit diesem Branch verknüpft sind, automatisch aktualisiert. git push --force origin my-branch.