サンプルに貢献する

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

知っておくべきこと

PR を作成するために知っておくべき blockly-samples に関する事実の概要を以下に示します。

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

  • 新しいコードファイルには、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 を実行すると、プラグインのテストページを実行するサーバーがビルドされ、起動します。このページでは、プラグインの既存の動作を確認できます。また、新しいプラグインを追加する場合は、他のユーザーがプラグインの動作を確認できるように、このページを便利なテストページにする必要があります。詳細については、プレイグラウンド ページをご覧ください。
  3. プラグインのコードに必要な変更を加えます。
  4. サーバーを実行したままにしている場合は、変更内容が自動的に読み込まれます。それ以外の場合は、サーバーを再起動し、プラグインが想定どおりに動作し、コンソールにエラーや警告が表示されないことを確認します。
  5. npm run build を実行し、ビルドエラーがないことを確認します。
  6. test/ ディレクトリに自動 mocha テストを記述します。
  7. npm run test を実行して自動テストを実行します。
  8. npm run lint:fix を実行して、lint エラーを修正します。残りの警告やエラーに対処します。
  9. npm run format を実行して自動フォーマッタを実行します。
  10. すべてのテストに合格したら、変更内容を含む main に対して PR を開く準備が整います。