Посібник для контриб'юторів Laravel Maestro

Laravel використовує Maestro для створення Starter Kits. Документації щодо внеску в ці набори небагато.

Якщо ви хочете додати нові функції або виправити помилки в Starter Kit, вам потрібно розуміти робочий процес. Цей посібник пояснює, як правильно використовувати Maestro.

Структура директорій

Репозиторій має три основні частини:

  • kits/: Тут містяться фактичні файли Starter Kit. Це єдина директорія, яку ви додаєте в коміт.
  • orchestrator/: Керує процесом збірки та запускає набори (kits).
  • build/: Це тимчасова робоча область. Maestro створює її під час запуску збірки.

Робочий процес розробки

Не працюйте безпосередньо в директорії kits/, хіба що ви оновлюєте багато файлів одночасно. Замість цього виконайте такі кроки:

  1. Налаштуйте середовище Перейдіть до папки orchestrator/. Виконайте composer install та npm install.

  2. Зберіть цільовий набір Виконайте php artisan build. Виберіть свій фреймворк, варіант та функції. Це створить папку build/.

  3. Запустіть набір Використовуйте composer kit:run із папки orchestrator/. Це запустить застосунок на порту 8000.

  4. Внесіть зміни Відкрийте директорію build/. Знайдіть файли, які потрібно змінити, і відредагуйте їх.

  5. Дозвольте watcher-у зробити свою роботу Maestro використовує watcher. Коли ви зберігаєте файл у build/, він автоматично оновлює відповідний файл у директорії kits/.

  6. Перевірте свої зміни Спочатку зупиніть процес kit:run. Ви не можете запускати тести, поки набір працює. З папки orchestrator/ виконайте:

  • composer kits:pint (для форматування)
  • composer kits:check (для PHP-тестів)
  • composer kits:lint (для JavaScript-тестів)
  1. Зафіксуйте свою роботу Перевірте статус git. Ви маєте побачити зміни в папці kits/. Додавайте до коміту лише директорію kits/.

Приклад: Зміна тексту з "Log in" на "Log on"

  • Відредагуйте blade-файл або файл компонента всередині build/.
  • Зачекайте, поки watcher оновить kits/.
  • Запустіть тести, щоб переконатися, що ви не зламали інші варіанти.
  • Зафіксуйте (commit) файли в kits/.

Цей процес гарантує, що ваш внесок буде чистим і відповідатиме архітектурі Maestro.

Джерело: https://dev.to/catatsumuri/laravel-maestro-contributor-tutorial-2p89