Laravel Maestro Contributor-Tutorial

Laravel verwendet Maestro, um Starter Kits zu erstellen. Die Dokumentation für das Mitwirken an diesen Kits ist spärlich.

Wenn Sie Funktionen hinzufügen oder Fehler in einem Starter Kit beheben möchten, müssen Sie den Workflow verstehen. Dieser Leitfaden erklärt, wie Sie Maestro korrekt verwenden.

Die Verzeichnisstruktur

Das Repository besteht aus drei Hauptteilen:

  • kits/: Hier befinden sich die eigentlichen Starter-Kit-Dateien. Dies ist das einzige Verzeichnis, das Sie committen.
  • orchestrator/: Dieses Verzeichnis verwaltet den Build-Prozess und führt die Kits aus.
  • build/: Dies ist ein temporärer Arbeitsbereich. Maestro erstellt diesen, wenn Sie einen Build ausführen.

Der Entwicklungs-Workflow

Arbeiten Sie nicht direkt im Verzeichnis kits/, es sei denn, Sie aktualisieren viele Dateien gleichzeitig. Befolgen Sie stattdessen diese Schritte:

1. Umgebung einrichten

Navigieren Sie in den Ordner orchestrator/. Führen Sie composer install und npm install aus.

2. Das Ziel-Kit bauen

Führen Sie php artisan build aus. Wählen Sie Ihr Framework, Ihre Variante und Ihre Funktionen aus. Dadurch wird der Ordner build/ erstellt.

3. Das Kit ausführen

Verwenden Sie composer kit:run aus dem Ordner orchestrator/. Dies startet die Anwendung auf Port 8000.

4. Änderungen vornehmen

Öffnen Sie das Verzeichnis build/. Suchen Sie die Dateien, die Sie ändern müssen, und bearbeiten Sie diese.

5. Den Watcher arbeiten lassen

Maestro verwendet einen Watcher. Wenn Sie eine Datei in build/ speichern, wird automatisch die entsprechende Datei im Verzeichnis kits/ aktualisiert.

6. Änderungen testen

Stoppen Sie zuerst den kit:run-Prozess. Sie können keine Tests ausführen, während das Kit läuft. Führen Sie aus dem Ordner orchestrator/ Folgendes aus:

  • composer kits:pint (für die Formatierung)
  • composer kits:check (für PHP-Tests)
  • composer kits:lint (für JavaScript-Tests)

7. Arbeit committen

Überprüfen Sie Ihren Git-Status. Sie sollten Änderungen im Ordner kits/ sehen. Fügen Sie nur das Verzeichnis kits/ Ihrem Commit hinzu.

Beispiel: Text von "Log in" zu "Log on" ändern

  • Bearbeiten Sie die Blade- oder Component-Datei innerhalb von build/.
  • Warten Sie, bis der Watcher kits/ aktualisiert hat.
  • Führen Sie Tests aus, um sicherzustellen, dass Sie keine anderen Varianten beschädigt haben.
  • Committen Sie die Dateien in kits/.

Dieser Prozess stellt sicher, dass Ihr Beitrag sauber bleibt und der Maestro-Architektur folgt.

Quelle: https://dev.to/catatsumuri/laravel-maestro-contributor-tutorial-2p89