Laravel Maestro 贡献者教程

Laravel 使用 Maestro 来构建 Starter Kits。关于如何为这些 kit 做出贡献的文档非常匮乏。

如果你想在 Starter Kit 中添加功能或修复 Bug，你需要了解其工作流程。本指南将解释如何正确使用 Maestro。

目录结构

该仓库包含三个主要部分：

  • kits/：存放实际的 Starter Kit 文件。这是你唯一需要提交的目录。
  • orchestrator/：管理构建过程并运行 kits。
  • build/：这是一个临时工作区。当你运行构建时，Maestro 会创建此目录。

开发工作流程

除非你要一次性更新大量文件，否则请勿直接在 kits/ 目录中工作。相反，请遵循以下步骤：

  1. 设置环境 进入 orchestrator/ 文件夹。运行 composer install 和 npm install。

  2. 构建你的目标 kit 运行 php artisan build。选择你的框架、变体（variant）和功能。这将创建 build/ 文件夹。

  3. 运行 kit 在 orchestrator/ 文件夹中运行 composer kit:run。这将在 8000 端口启动应用程序。

  4. 进行更改 打开 build/ 目录。找到需要修改的文件并进行编辑。

  5. 让监听器（watcher）工作 Maestro 使用了一个监听器。当你保存 build/ 中的文件时，它会自动更新 kits/ 目录中对应的文件。

  6. 测试你的更改 首先停止 kit:run 进程。在 kit 运行时无法进行测试。在 orchestrator/ 文件夹中运行：

  • composer kits:pint（用于格式化）
  • composer kits:check（用于 PHP 测试）
  • composer kits:lint（用于 JavaScript 测试）
  1. 提交你的工作 检查你的 git 状态。你应该能在 kits/ 文件夹中看到更改。仅将 kits/ 目录添加到你的提交中。

示例：将文本从 "Log in" 改为 "Log on"

  • 在 build/ 内部编辑 blade 或 component 文件。
  • 等待监听器更新 kits/。
  • 运行测试以确保你没有破坏其他变体。
  • 提交 kits/ 中的文件。

此流程可确保你的贡献保持整洁并遵循 Maestro 架构。

来源：https://dev.to/catatsumuri/laravel-maestro-contributor-tutorial-2p89