开始为 Blockly 贡献

Blockly 是开源的,主要由一个小团队维护。我们欢迎核心团队以外的开发者做出贡献;如果没有社区的支持,我们无法构建所有请求的功能或修复所有报告的 bug。 本部分包含一些通用指南,如果您是开源开发新手,这些指南可能会对您有所帮助。

如需了解在贡献代码之前应阅读的 Blockly 相关信息,请参阅为核心代码贡献代码为示例贡献代码部分。

哪个代码库?

代码库包含单个项目的所有文件。Blockly 有两个代码库:blockly 核心代码库和 blockly-samples 代码库。

Blockly 核心是 Blockly 库的代码库。如果您想以适用于库的所有用户的方式更改核心 Blockly 行为,请使用此代码库。

Blockly 示例是包含示例、插件和 Codelab 的代码库。如果您想创建或修改插件、编写 Codelab 或创建/修改示例,请使用此代码库。

分步说明

无论何时进行更改,您都需要遵循以下一般步骤。

  1. 按照工具部分中的链接安装 Git 和 Node。
  2. 创建代码库分支并克隆代码库。GitHub 上有一篇关于派生代码库的精彩教程。 如需将其应用于 Blockly,只需将 octocat/Spoon-Knife 的每个实例替换为 RaspberryPiFoundation/blocklyRaspberryPiFoundation/blockly-samples,具体取决于您要使用的代码库。
  3. 同步您的 Fork。GitHub 还提供了一个关于同步派生版本的教程。
  4. 签出 main 分支。在 Blockly 核心中,这是 develop 分支。在 blockly-samples 中,这是 master 分支。
  5. 在根目录中运行 npm install,以安装依赖项和 build 工具。
  6. 在终端中运行 git checkout -b myBranchName创建新分支。该名称应有助于您记住自己正在处理的任务。
  7. 进行更改。
  8. 按照核心示例指南验证您的更改
  9. 使用 git commit -am "fix: My commit message" 保存您的更改详细了解提交消息
  10. 使用 git push origin myBranchName 将更改推送到 GitHub
  11. 代码准备就绪后,打开拉取请求。Blockly 团队的成员会审核您的更改,并在获得批准后将其合并到 Blockly 中。如需了解详情,请参阅 PR 审核流程