為核心貢獻心力

Blockly 核心存放區包含執行任何區塊式應用程式所需的程式碼。

重要須知

以下簡要說明建立 PR 時必須瞭解的區塊核心相關資訊。

  • 運作中的分支版本為「develop」，所有 PR 都應根據開發用途建立。
  • 您必須按照要求的資訊填寫提取要求範本。
  • 程式碼必須符合 Google 的 TypeScript 樣式指南。
  • 在修訂訊息和提取要求標題中使用傳統修訂版本。
  • 使用者可看見的字串必須位於 /msg/messages.js 檔案中，才能提供翻譯。只有不到 6% 的全球使用英文母語。
  • 區塊上的文字通常應全部小寫 (就像大多數程式設計語言中的關鍵字一樣)。
  • 保持回溯相容性。封鎖狀態應用程式有很多，別破壞其他人。

  • 所有新的程式碼檔案都必須以 Apache 授權 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。