コアに貢献する

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

知っておくべきこと

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

  • 作業ブランチは main で、すべての PR は main に対して作成する必要があります。
  • 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 を実行して、プレイグラウンドを実行するサーバーを起動します。このページを使用して、既存の動作をテストできます。詳細については、プレイグラウンドのページをご覧ください。
  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. すべてのテストに合格したら、変更内容を含む main に対して PR を開く準備が整います。