Tutorial Kontributor Laravel Maestro

Laravel menggunakan Maestro untuk membangun Starter Kit. Dokumentasi untuk berkontribusi pada kit ini masih sangat minim.

Jika Anda ingin menambahkan fitur atau memperbaiki bug dalam sebuah Starter Kit, Anda perlu memahami alur kerjanya. Panduan ini menjelaskan cara menggunakan Maestro dengan benar.

Struktur Direktori

Repositori ini memiliki tiga bagian utama:

  • kits/: Ini berisi file Starter Kit yang sebenarnya. Ini adalah satu-satunya direktori yang Anda commit.
  • orchestrator/: Ini mengelola proses build dan menjalankan kit.
  • build/: Ini adalah ruang kerja sementara. Maestro membuat direktori ini saat Anda menjalankan build.

Alur Kerja Pengembangan

Jangan bekerja langsung di direktori kits/ kecuali jika Anda memperbarui banyak file sekaligus. Sebaliknya, ikuti langkah-langkah berikut:

  1. Siapkan lingkungan Masuk ke folder orchestrator/. Jalankan composer install dan npm install.

  2. Build kit target Anda Jalankan php artisan build. Pilih framework, varian, dan fitur Anda. Ini akan membuat folder build/.

  3. Jalankan kit Gunakan composer kit:run dari folder orchestrator/. Ini akan menjalankan aplikasi pada port 8000.

  4. Lakukan perubahan Anda Buka direktori build/. Temukan file yang perlu Anda ubah dan edit file tersebut.

  5. Biarkan watcher bekerja Maestro menggunakan watcher. Saat Anda menyimpan file di build/, ia akan secara otomatis memperbarui file yang tepat di direktori kits/.

  6. Uji perubahan Anda Hentikan proses kit:run terlebih dahulu. Anda tidak dapat menjalankan pengujian saat kit sedang berjalan. Dari folder orchestrator/, jalankan:

  • composer kits:pint (untuk pemformatan)
  • composer kits:check (untuk pengujian PHP)
  • composer kits:lint (untuk pengujian JavaScript)
  1. Commit pekerjaan Anda Periksa status git Anda. Anda seharusnya melihat perubahan di folder kits/. Hanya tambahkan direktori kits/ ke dalam commit Anda.

Contoh: Mengubah teks dari "Log in" menjadi "Log on"

  • Edit file blade atau komponen di dalam build/.
  • Tunggu watcher memperbarui kits/.
  • Jalankan pengujian untuk memastikan Anda tidak merusak varian lainnya.
  • Commit file di kits/.

Proses ini memastikan kontribusi Anda tetap bersih dan mengikuti arsitektur Maestro.

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