「試聴する」への貢献

Blockly サンプルには、プラグイン、Codelab、サンプルコードなど、コア リポジトリに含まれない Blockly 関連の追加コンテンツが含まれています。これらの各ファイルの詳細については、リポジトリ構造のページをご覧ください。

必知事項

PR を作成するために知っておく必要のある、blockly-samples に関する事実の概要は次のとおりです。

  • 作業ブランチは master であり、すべての PR は master に対して作成する必要があります。
  • 個々のプラグイン レベルではなく、blockly-samples のルートレベルで npm install を実行します。Blockly-samples は単一リポジトリです。つまり、同じリポジトリに複数のパッケージが含まれています。ルートレベルにインストールすることは、Lerna で単一リポジトリを管理するワークフローの一部です。
  • コードは、使用している言語に応じて、Google の JavaScript スタイルガイドまたは TypeScript スタイルガイドに準拠している必要があります。
  • commit メッセージと pull リクエストのタイトルでは、従来の commit を使用します。

  • 新しいコードファイルには、Apache License 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 を実行して lint エラーを修正します。残りの警告やエラーに対処します。
  9. npm run format を実行して自動フォーマッタを実行します。
  10. すべてのテストに合格したら、変更を加えた master に対して PR を開く準備が整います。