為「發現」貢獻心力

Blockly Samples 包含其他不屬於核心存放區的 Blockly 相關額外內容，包括外掛程式、程式碼研究室和程式碼範例。如要進一步瞭解這些設定，請參閱存放區結構頁面。

重要須知

以下簡要說明建立 PR 時需瞭解的區塊範例相關事實。

  • 工作分支版本為「主要」，而所有 PR 都應根據主要執行個體建立。
  • 在區塊 ly-samples 的根層級執行 npm install，而不是在個別外掛程式層級執行。Blockly-samples 是單詞存放區，代表其包含同一個存放區中的多個套件，而在根層級安裝，就是使用 Lerna 管理單體存放區的工作流程的一部分。
  • 視所用語言而定，程式碼必須符合 Google 的 JavaScript 樣式指南或 TypeScript 樣式指南。
  • 在修訂訊息和提取要求標題中使用傳統修訂版本。

  • 所有新的程式碼檔案都必須以 Apache 授權 v2.0 開頭：

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

進行並驗證變更

  1. 在區塊範例的根層級執行 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. 如果所有測試都通過，您就可以透過變更，對「主要」建立 PR。