Laravel Maestro 기여자 튜토리얼
Laravel은 Starter Kit을 구축하기 위해 Maestro를 사용합니다. 이러한 키트에 기여하기 위한 문서는 부족한 편입니다.
Starter Kit에 기능을 추가하거나 버그를 수정하려면 워크플로우를 이해해야 합니다. 이 가이드는 Maestro를 올바르게 사용하는 방법을 설명합니다.
디렉토리 구조
저장소는 세 가지 주요 부분으로 구성됩니다:
- kits/: 실제 Starter Kit 파일이 들어 있습니다. 이 디렉토리만 커밋하면 됩니다.
- orchestrator/: 빌드 프로세스를 관리하고 키트를 실행합니다.
- build/: 임시 작업 공간입니다. Maestro는 빌드를 실행할 때 이 디렉토리를 생성합니다.
개발 워크플로우
한 번에 많은 파일을 업데이트하는 경우가 아니라면 kits/ 디렉토리에서 직접 작업하지 마세요. 대신 다음 단계를 따르십시오:
환경 설정 orchestrator/ 폴더로 이동합니다. composer install과 npm install을 실행합니다.
대상 키트 빌드 php artisan build를 실행합니다. 프레임워크, variant, 기능을 선택합니다. 그러면 build/ 폴더가 생성됩니다.
키트 실행 orchestrator/ 폴더에서 composer kit:run을 사용합니다. 이렇게 하면 8000번 포트에서 애플리케이션이 시작됩니다.
변경 사항 적용 build/ 디렉토리를 엽니다. 변경이 필요한 파일을 찾아 편집합니다.
watcher 활용하기 Maestro는 watcher를 사용합니다. build/에서 파일을 저장하면 kits/ 디렉토리의 올바른 파일이 자동으로 업데이트됩니다.
변경 사항 테스트 먼저 kit:run 프로세스를 중단하십시오. 키트가 실행 중인 동안에는 테스트를 실행할 수 없습니다. orchestrator/ 폴더에서 다음을 실행합니다:
- composer kits:pint (포맷팅용)
- composer kits:check (PHP 테스트용)
- composer kits:lint (JavaScript 테스트용)
- 작업 커밋 git status를 확인합니다. kits/ 폴더에 변경 사항이 보여야 합니다. 커밋에는 kits/ 디렉토리만 추가하십시오.
예시: 텍스트를 "Log in"에서 "Log on"으로 변경하기
- build/ 내부의 blade 또는 컴포넌트 파일을 편집합니다.
- watcher가 kits/를 업데이트할 때까지 기다립니다.
- 다른 variant를 망가뜨리지 않았는지 테스트를 실행합니다.
- kits/에 있는 파일들을 커밋합니다.
이 프로세스는 귀하의 기여가 깔끔하게 유지되고 Maestro 아키텍처를 따르도록 보장합니다.
출처: https://dev.to/catatsumuri/laravel-maestro-contributor-tutorial-2p89
