为核心贡献

Blockly 核心代码库包含运行任何基于 Blockly 的应用所需的代码。

重要须知

下面简要介绍了您在创建 PR 时需要了解的有关 Blockly 核心的事实。

  • 工作分支为 main，所有 PR 都应针对 main 分支创建。
  • 您必须在拉取请求模板中填写所需信息。
  • 代码必须符合 Google 的 TypeScript 样式指南。
  • 在提交消息和拉取请求标题中使用规范化提交。
  • 面向用户的字符串必须位于 /msg/messages.js 文件中，以便进行翻译。全球只有不到 6% 的人以英语为母语。
  • 块上的文字通常应全部小写（就像大多数编程语言中的关键字一样）。
  • 保持向后兼容性。市面上有很多 Blockly 应用，请不要破坏其他人的应用。

  • 任何新的代码文件都必须以 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 并确保没有 build 错误。
  6. 编写自动化测试。通常，这些测试将是 tests/mocha 目录中的 Mocha 测试，但我们也可能会要求您提供其他类型的测试。
  7. 运行 npm run format 以格式化代码并自动修复一些 lint 问题。
  8. 运行 npm test 以运行自动化测试。这也会运行 eslint。
  9. 如果存在 lint 错误，请运行 npm run lint:fix 以修复可自动修复的问题。解决所有剩余的 lint 警告或错误。
  10. 如果所有测试都通过，您就可以针对 main 打开包含您的更改的 PR 了。