为核心业务做贡献

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

重要须知

以下简要介绍了创建 PR 时需要了解的 Blockly Core 相关信息。

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

  • 所有新代码文件都必须带有 Apache License 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 了。