Blockly サンプルには、プラグイン、Codelab、サンプルコードなど、コア リポジトリの一部ではない Blockly 関連の追加コンテンツが含まれています。それぞれの詳細については、リポジトリの構造のページをご覧ください。
知っておくべきこと
ここでは、PR を作成する際に知っておくべき blockly-samples について簡単に説明します。
- 作業ブランチは master であり、すべての PR は master に対して作成される必要があります。
- 個々のプラグイン レベルではなく、blockly-samples のルートレベルで
npm install
を実行します。Blockly-samples は monorepo です。つまり、同じリポジトリに複数のパッケージが含まれています。ルートレベルでのインストールは、Lerna で monorepo を管理するワークフローの一部です。 - コードは、使用する言語に応じて Google の JavaScript スタイルガイドまたは TypeScript スタイルガイドに準拠している必要があります。
- commit メッセージと pull リクエスト タイトルで従来の commit を使用します。
新しいコードファイルには、次のように Apache License v2.0 という接頭辞を付ける必要があります。
/** * @license * Copyright <Current YYYY> Google LLC * SPDX-License-Identifier: Apache-2.0 */
変更して確認する
- blockly-samples のルートレベルで
npm install
を実行して、依存関係をインストールします。 - プラグインのディレクトリで
npm run start
を実行し、プラグインのテストページを実行するサーバーをビルドして起動します。このページを使用して、プラグインの既存の動作を確認できます。また、新しいプラグインを追加する場合は、他のユーザーがプラグインの動作を確認できるように、便利なテストページにする必要があります。詳しくは、playground ページをご覧ください。 - プラグインのコードに必要な変更を加えます。
- サーバーを実行したままにしておくと、変更が自動的に読み込まれます。それ以外の場合は、サーバーを再起動して、プラグインが期待どおりに動作し、コンソールにエラーや警告がないことを確認します。
npm run build
を実行し、ビルドエラーがないことを確認します。- 自動 mocha テストを
test/
ディレクトリに記述します。 npm run test
を実行して自動テストを実行します。npm run lint:fix
を実行して lint エラーを修正します。残っている警告やエラーがあれば対処します。npm run format
を実行して自動フォーマット機能を実行します。- すべてのテストに合格したら、変更を反映して master に対して PR を開くことができます。