為核心貢獻心力

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

重要須知

以下快速總覽 Blockly 核心的相關事實，方便您建立 PR。

  • 工作分支是 main，所有 PR 都應針對 main 建立。
  • 請務必填寫提取要求範本中的必要資訊。
  • 程式碼必須符合 Google 的 TypeScript 樣式指南。
  • 在提交訊息和提取要求標題中使用傳統提交。
  • 使用者可見的字串必須位於 /msg/messages.js 檔案中，才能進行翻譯。全球只有不到 6% 的人以英語為母語。
  • 方塊上的文字通常應全部為小寫 (就像大多數程式設計語言中的關鍵字一樣)。
  • 維持回溯相容性。市面上有很多 Blockly 應用程式，請勿影響其他使用者。

  • 所有新程式碼檔案都必須加上 Apache 2.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，並提交變更。