샘플에 참여하기

Blockly 샘플에는 플러그인, 코드랩, 예시 코드 등 핵심 저장소에 포함되지 않은 Blockly 관련 추가 콘텐츠가 포함되어 있습니다. 각 항목에 대한 자세한 내용은 저장소 구조 페이지를 참고하세요.

알아두어야 할 사항

다음은 PR을 만드는 데 필요한 blockly-samples에 관한 사실을 간략하게 설명한 것입니다.

  • 작업 브랜치는 main이며 모든 PR은 main에 대해 이루어져야 합니다.
  • 개별 플러그인 수준이 아닌 blockly-samples의 루트 수준에서 npm install를 실행합니다. Blockly-samples는 모노리포입니다. 즉, 동일한 저장소에 여러 패키지가 포함되어 있으며 루트 수준에서 설치하는 것은 Lerna로 모노리포를 관리하는 워크플로의 일부입니다.
  • 코드는 사용된 언어에 따라 Google의 JavaScript 스타일 가이드 또는 TypeScript 스타일 가이드를 준수해야 합니다.
  • 커밋 메시지와 풀 요청 제목에 컨벤셔널 커밋을 사용하세요.

  • 새 코드 파일에는 Apache 라이선스 v2.0이 접두사로 붙어야 합니다.

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

변경사항 적용 및 확인

  1. blockly-samples의 루트 수준에서 npm install을 실행하여 종속 항목을 설치합니다.
  2. 플러그인 디렉터리에서 npm run start를 실행하여 플러그인의 테스트 페이지를 실행하는 서버를 빌드하고 시작합니다. 이 페이지를 사용하여 플러그인의 기존 동작을 확인할 수 있습니다. 새 플러그인을 추가하는 경우 다른 사용자가 플러그인의 기능을 확인할 수 있도록 이 페이지를 유용한 테스트 페이지로 만들어야 합니다. 자세한 내용은 playground 페이지를 참고하세요.
  3. 플러그인 코드를 필요한 대로 변경합니다.
  4. 서버를 실행한 상태로 두면 변경사항이 자동으로 로드됩니다. 그렇지 않으면 서버를 다시 시작하고 플러그인이 예상대로 작동하며 콘솔에 오류나 경고가 없는지 확인합니다.
  5. npm run build를 실행하고 빌드 오류가 없는지 확인합니다.
  6. test/ 디렉터리에 자동화된 Mocha 테스트를 작성합니다.
  7. npm run test를 실행하여 자동 테스트를 실행합니다.
  8. npm run lint:fix를 실행하여 린트 오류를 수정합니다. 남은 경고나 오류를 해결합니다.
  9. npm run format를 실행하여 자동 포맷터를 실행합니다.
  10. 모든 테스트를 통과하면 변경사항을 포함하여 main에 대해 PR을 열 수 있습니다.