提供範例

Blockly 範例包含與 Blockly 相關的額外內容，但不屬於核心存放區的一部分，包括外掛程式、程式碼研究室和範例程式碼。如要進一步瞭解這些項目，請參閱「存放區結構」頁面。

重要須知

以下簡要說明 Blockly 範例的相關資訊，您必須瞭解這些資訊才能建立提交要求。

  • 工作分支是 master，所有 PR 都應針對 master 建立。
  • 請在 blockly-samples 的根層級執行 npm install，而不是在個別外掛程式層級執行。Blockly-samples 是單一版本控制庫，也就是說，它在同一個版本控制庫中包含多個套件，而以根層級安裝是使用 Lerna 管理單一版本控制庫的工作流程的一部分。
  • 程式碼必須符合 Google 的 JavaScript 樣式指南或 TypeScript 樣式指南，具體取決於所使用的語言。
  • 在提交訊息和提取要求標題中使用傳統提交。

  • 任何新的程式碼檔案都必須在前面加上 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，並在其中加入變更。