Laravel Maestro Contributor Tutorial

Laravel משתמשת ב-Maestro כדי לבנות Starter Kits. התיעוד בנוגע לתרומה לערכות אלו הוא דל.

אם ברצונכם להוסיף תכונות או לתקן באגים ב-Starter Kit, עליכם להבין את תהליך העבודה (workflow). מדריך זה מסביר כיצד להשתמש ב-Maestro בצורה נכונה.

The Directory Structure

למאגר יש שלושה חלקים עיקריים:

  • kits/: כאן נמצאים קבצי ה-Starter Kit עצמם. זוהי התיקייה היחידה שעליה אתם מבצעים commit.
  • orchestrator/: מנהלת את תהליך הבנייה (build) ומריצה את ה-kits.
  • build/: זהו מרחב עבודה זמני. Maestro יוצרת אותו כאשר מריצים build.

The Development Workflow

אל תעבדו ישירות בתוך תיקיית kits/ אלא אם כן אתם מעדכנים קבצים רבים בבת אחת. במקום זאת, פעלו לפי השלבים הבאים:

  1. Setup the environment עברו לתיקיית orchestrator/. הריצו composer install ו-npm install.

  2. Build your target kit הריצו php artisan build. בחרו את ה-framework, ה-variant והתכונות (features) שלכם. פעולה זו תיצור את תיקיית build/.

  3. Run the kit השתמשו ב-composer kit:run מתוך תיקיית orchestrator/. פעולה זו תפעיל את האפליקציה בפורט 8000.

  4. Make your changes פתחו את תיקיית build/. מצאו את הקבצים שברצונכם לשנות וערוך אותם.

  5. Let the watcher work Maestro משתמשת ב-watcher. כאשר אתם שומרים קובץ ב-build/, הוא מעדכן באופן אוטומטי את הקובץ המתאים בתיקיית kits/.

  6. Test your changes עצרו תחילה את תהליך ה-kit:run. לא ניתן להריץ בדיקות בזמן שה-kit פועל. מתוך תיקיית orchestrator/, הריצו:

  • composer kits:pint (עבור עיצוב קוד/formatting)
  • composer kits:check (עבור בדיקות PHP)
  • composer kits:lint (עבור בדיקות JavaScript)
  1. Commit your work בדקו את ה-git status שלכם. אתם אמורים לראות שינויים בתיקיית kits/. הוסיפו רק את תיקיית kits/ ל-commit שלכם.

Example: Changing text from "Log in" to "Log on"

  • ערוך את קובץ ה-blade או ה-component בתוך build/.
  • המתן שה-watcher יעדכן את kits/.
  • הרץ בדיקות כדי לוודא שלא שברתם variants אחרים.
  • בצע commit לקבצים ב-kits/.

תהליך זה מבטיח שהתרומה שלכם תישאר נקייה ותעקוב אחר הארכיטקטורה של Maestro.

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