Verbessern Sie Ihren Pull-Request-Workflow mit pull-request-codecommit

In meinem letzten Blogbeitrag habe ich geschrieben, warum es wichtig ist, gute Commit-Nachrichten zu schreiben. In diesem Beitrag werde ich ein Beispiel dafür anführen, wie dies zu Ihrem Vorteil funktioniert. Verwendung eines AWS CodeCommit-Repositorys.

Arbeitsbeispiel

Gut, nehmen wir an, wir haben ein Projekt, das einen main Zweig verwendet. In Kombination mit Feature-Zweigen. Wir möchten unserem Projekt ein Feature hinzufügen, also erstellen wir einen Zweig mit dem Namen: feat/my-feature.

Angenommen, wir schaffen es, die Funktion in einem einzigen Commit zum Laufen zu bringen. Die Commit-Nachricht würde dann etwa so aussehen:

feat: Unterstützung für x hinzufügen Indem wir Unterstützung für x hinzufügen, ermöglichen wir x Benutzern, dieses Tool in ihren Arbeitsablauf zu übernehmen. Ausgabe: #123

Jetzt ist es an der Zeit, eine Pull-Anfrage zu erstellen! Ich habe ein Tool namens pull-request-codecommit erstellt.Dieses Tool prüft die Unterschiede zwischen dem aktuellen Zweig. und dem Zielzweig und schlägt eine Pull-Request-Nachricht vor.

Wenn Sie also eine Pull-Anfrage erstellen möchten, geben Sie ein:

git pr

Der Standard-Editor wird geöffnet. Und in diesem Editor werden Sie sehen:

feat: add support for x (#123)

By adding support for x we allow x users to adopt this tool in their workflow.

Issue: #123

Die erste Zeile wird als Titel und der Rest als Beschreibung verwendet. Sie können die Nachricht nach Belieben ändern, aber wenn Sie eine richtige Commit-Nachricht verwenden, ist diese bereits genau richtig. Wenn Sie den Vorschlag speichern, wird die Pull-Anfrage für Sie erstellt:

Der Einfachheit halber wird der Link und die eventuelle Nachricht angezeigt. Wenn Sie den Link öffnen, sieht die Pull-Anfrage wie folgt aus:

Was ist mit vielen Übertragungen?

Wenn viele Commits verwendet werden, versucht das Tool, eine gute Pull-Request-Nachricht vorzuschlagen. Wenn Sie Ihre Commits aufteilen. Und Sie die richtigen Nachrichten verwenden, sieht es ungefähr so aus:

Wie Sie sehen können, wird der erste Commit als Titel verwendet. Die übrigen Commit-Titel werden in der Beschreibung als Liste angezeigt.

Schlussfolgerung

Wenn Sie richtige Commit-Nachrichten schreiben, helfen Sie sich selbst. Es macht es Ihnen leichter, Pull Requests zu verfassen. Und es ermöglicht Ihnen, Tools zu nutzen, weil Sie Standards verwenden.