为核心业务做贡献

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

注意事项

下面简要概述了关于创建 PR 需要了解的块状核心的事实。

  • 工作分支是“开发”，所有 PR 都应该与“开发”对应。
  • 您必须使用要求的信息填写拉取请求模板。
  • 代码必须符合 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 的服务器。您可以使用此页面测试现有行为。如需了解详情，请参阅 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。