コアに貢献する

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

必知事項

PR を作成する際に知っておく必要のある Blockly コアに関する事実の概要を次に示します。

  • 作業ブランチは develop であり、すべての PR は develop に対して作成する必要があります。
  • 必要な情報を pull リクエスト テンプレートに入力する必要があります。
  • コードは Google の TypeScript スタイルガイドに準拠している必要があります。
  • コミット メッセージと pull リクエストのタイトルに従来のコミットを使用します。
  • ユーザーに表示される文字列は、翻訳できるように /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 を実行するサーバーを起動します。このページを使用して、既存の動作をテストできます。詳細については、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 を開く準備が整います。