Blockly 示例包含与 Blockly 相关但不属于核心代码库的额外内容,包括插件、Codelab 和示例代码。如需详细了解其中的每种类型,请参阅代码库结构页面。
重要须知
以下简要介绍了有关 blockly-samples 的事实,您需要了解这些事实才能创建 PR。
- 工作分支为 master,所有 PR 都应针对 master 提交。
- 在 blockly-samples 的根级运行
npm install
,而不是在单个插件级运行。Blockly-samples 是一个单仓库,这意味着它在同一个仓库中包含多个软件包,并且在根级别进行安装是使用 Lerna 管理单仓库的工作流程的一部分。 - 代码必须符合 Google 的 JavaScript 样式指南或 TypeScript 样式指南,具体取决于所使用的语言。
- 在提交消息和拉取请求标题中使用常规提交。
所有新代码文件都必须带有 Apache License v2.0 前缀:
/** * @license * Copyright <Current YYYY> Google LLC * SPDX-License-Identifier: Apache-2.0 */
进行更改并进行验证
- 在 blockly-samples 的根级别运行
npm install
以安装依赖项。 - 在插件目录中运行
npm run start
以构建并启动运行插件测试页面的服务器。您可以使用此页面查看插件的现有行为;如果您要添加新的插件,则需要将此页面打造为实用的测试页面,以便其他人了解您的插件功能。如需了解详情,请参阅Playground 页面。 - 对插件代码进行必要的更改。
- 如果您让服务器保持运行状态,您所做的更改将自动加载。 否则,请重启服务器,并验证该插件是否按预期运行,以及控制台中是否没有错误或警告。
- 运行
npm run build
,并确保没有构建错误。 - 在
test/
目录中编写自动化 mocha 测试。 - 运行
npm run test
以运行自动化测试。 - 运行
npm run lint:fix
以修复 lint 错误。解决所有剩余的警告或错误。 - 运行
npm run format
以运行自动格式设置工具。 - 如果所有测试都通过,您就可以针对 master 打开包含所做更改的 PR 了。