Teamkonventionen für Branches, Commits und Pull Requests anwenden

Mit Pro oder Pro AI kann ein Team seine Konventionen in einem Vorlagensatz in Maestro hinterlegen. Eine berechtigte Person richtet den Satz ein und aktiviert ihn für die Organisation. Melden Sie sich an und synchronisieren Sie Riff, um die Vorlagen auf Ihrem Rechner zu verwenden.

Eine Konvention an einer Änderung ausprobieren

  1. Legen Sie einen Branch für einen Fix im Bestellvorgang an. Das Muster ^fix/[a-z0-9-]+$ erlaubt beispielsweise fix/empty-cart. Riff prüft den Namen während der Eingabe. Bei Abweichungen sehen Sie das Beispiel des Teams oder das Muster.
  2. Wählen Sie im Commit-Bereich eine Vorlage wie fix({area}): {summary}. Tragen Sie checkout für den Bereich und handle empty carts für die Zusammenfassung ein. Fügen Sie das Ergebnis ein und prüfen Sie den Text. Die erste Zeile bildet den Betreff, die weiteren Zeilen die Beschreibung.
  3. Wählen Sie beim Anlegen eines Pull Requests dessen Vorlage, füllen Sie die Variablen aus und wenden Sie die Vorlage an. Prüfen Sie Titel, Beschreibung sowie Quell- und Zielbranch und erstellen Sie die Anfrage.

Was die Validierung steuert

Vorschlag und Warnung geben Hinweise und lassen Sie fortfahren. Der Modus Blockieren verhindert das Anlegen eines Branches, dessen Name gegen eine blockierende Regel verstößt. Bei einer Commit-Vorlage verhindert er das Einfügen der Vorlage, solange Pflichtfelder fehlen. Bei einer PR-Vorlage verhindert er das Anwenden der Vorlage, bis die Felder ausgefüllt sind. Der erzeugte Text bleibt bearbeitbar. Ungültige reguläre Ausdrücke für Branch-Namen überspringt die Prüfung.

Nach der Anmeldung können Sie Ihren Gapfy-Namen und Ihre E-Mail-Adresse als Commit-Autor verwenden. Die Organisation kann diese Identität vorschreiben. Prüfen Sie die Einstellung vor dem Commit, falls Sie die Wahl haben. Um vorhandene Commit-Titel anhand des aktiven Nachrichtenmusters auszuwerten, starten Sie eine Konformitätsprüfung.