贡献示例

Blockly 示例包含与 Blockly 相关的额外内容，这些内容不属于核心代码库，包括插件、Codelab 和示例代码。如需详细了解这些内容，请参阅代码库结构页面。

重要须知

下面简要介绍了您在创建 PR 时需要了解的有关 blockly-samples 的事实。

  • 工作分支为 main，所有 PR 都应针对 main 分支创建。
  • 在 blockly-samples 的根级层（而非在各个插件级层）运行 npm install。Blockly-samples 是一个单体代码库，这意味着它在同一代码库中包含多个软件包，并且在根级别进行安装是使用 Lerna 管理单体代码库的工作流的一部分。
  • 代码必须符合 Google 的 JavaScript 样式指南或 TypeScript 样式指南（具体取决于所使用的语言）。
  • 在提交消息和拉取请求标题中使用规范化提交。

  • 任何新的代码文件都必须以 Apache 许可 v2.0 为前缀：

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

进行更改并验证更改

  1. 在 blockly-samples 的根级别运行 npm install 以安装依赖项。
  2. 在插件的目录中运行 npm run start，以构建并启动运行插件测试页面的服务器。您可以使用此页面查看插件的现有行为；如果您要添加新插件，则需要将此页面设为有用的测试页面，以便其他人了解您的插件的功能。如需了解详情，请参阅实验平台页面。
  3. 对插件的代码进行任何必要的更改。
  4. 如果您让服务器保持运行状态，系统会自动加载您的更改。 否则，请重启服务器，并验证插件是否按预期运行，以及控制台中是否没有错误或警告。
  5. 运行 npm run build 并确保没有 build 错误。
  6. 在 test/ 目录中编写自动化 Mocha 测试。
  7. 运行 npm run test 以运行自动化测试。
  8. 运行 npm run lint:fix 以修正 lint 错误。解决所有剩余的警告或错误。
  9. 运行 npm run format 以运行自动格式化程序。
  10. 如果所有测试都通过，您就可以针对 main 打开包含您的更改的 PR 了。