开始为 Blockly 贡献

Blockly 是开源的,主要由一支小团队维护。我们欢迎核心团队以外的开发者贡献代码;如果没有社区的支持,我们就无法实现所有用户请求的功能或修复所有报告的 bug。本部分包含一些常规指南,可能对您有所帮助,尤其是对于刚开始接触开源开发的用户。

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

哪个代码库?

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

Blockly 核心是 Blockly 库的代码库。如果您想更改核心 Blockly 行为,并使更改应用于该库的所有用户,请使用此代码库。

Blockly 示例是存放示例、插件和 Codelab 的仓库。如果您要创建或修改插件、编写 Codelab 或创建或修改示例,请使用此代码库。

分步说明

每次进行更改时,您都需要遵循以下一般步骤。

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