핵심에 기여

Blockly 핵심 저장소에는 Blockly 기반 애플리케이션을 실행하는 데 필요한 코드가 포함되어 있습니다.

알아두어야 할 사항

다음은 PR을 만들기 위해 알아야 하는 Blockly 핵심에 관한 사실을 간략하게 설명합니다.

  • 작업 브랜치는 main이며 모든 PR은 main에 대해 이루어져야 합니다.
  • 요청된 정보를 사용하여 풀 요청 템플릿을 작성해야 합니다.
  • 코드는 Google의 TypeScript 스타일 가이드를 준수해야 합니다.
  • 커밋 메시지와 풀 요청 제목에 컨벤셔널 커밋을 사용하세요.
  • 사용자에게 표시되는 문자열은 번역될 수 있도록 /msg/messages.js 파일에 있어야 합니다. 전 세계 인구의 6% 미만이 영어를 모국어로 사용합니다.
  • 블록의 텍스트는 일반적으로 모두 소문자여야 합니다 (대부분의 프로그래밍 언어의 키워드와 마찬가지로).
  • 이전 버전과의 호환성을 유지합니다. Blockly 앱은 많이 있습니다. 다른 모든 앱을 망치지 마세요.
  • 새 코드 파일에는 Apache 라이선스 v2.0이 접두사로 붙어야 합니다.

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

변경사항 적용 및 확인

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