コアに貢献する

Blockly コア リポジトリには、Blockly ベースのアプリケーションを実行するために必要なコードが含まれています。

知っておくべきこと

ここでは、PR を作成する際に知っておくべき Blockly Core の概要を簡単に説明します。

  • 作業ブランチは develop であり、すべての PR は develop に対して作成する必要があります。
  • pull リクエスト テンプレートに必要な情報を入力する必要があります。
  • コードは Google の TypeScript スタイルガイドに準拠している必要があります。
  • commit メッセージと pull リクエスト タイトルで従来の commit を使用します。
  • ユーザーに表示される文字列は、翻訳できるように /msg/messages.js ファイルに含める必要があります。英語を母語とする人は世界で 6% 未満です。
  • 通常、ブロックのテキストはすべて小文字にします（他のプログラミング言語のキーワードと同様）。
  • 下位互換性を維持する。Blockly アプリはたくさん公開されています。他のアプリを壊さないでください。

  • 新しいコードファイルには、次のように Apache License 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 を実行してコードをフォーマットし、lint の問題を自動的に修正します。
  8. npm test を実行して自動テストを実行します。これにより、eslint も実行されます。
  9. lint エラーがある場合は、npm run lint:fix を実行して、自動修正可能な問題を修正します。lint 警告やエラーが残っている場合は対処します。
  10. すべてのテストに合格したら、変更を反映して develop に対して PR を開くことができます。