贡献指南

我们非常感谢您为Makepad之书做出贡献!每一项的贡献都是对我们的支持,使我们能够不断完善Makepad之书,让更多喜欢Makepad的人受益。

提交pull request

  1. Fork 本仓库到你自己的GitHub个人仓库中。
  2. Clone 你Github仓库中的 makepad-book 到本地。
  3. preview 分支拉出一个新的分支,命名为 add/xxxupdate/xxx,或其他的分支名。
  4. 搭建开发环境,你可以阅读开发环境搭建部分来了解。
  5. 在本地修改你的分支,完成你的工作。
  6. 提交 Pull Request, 确保所有的 CI 都通过.
  7. 等待 Reviewer 的 Review,如果有需要,你需要根据 Reviewer 的意见进行修改,也可以选择同意相关建议。
注意

提交 Pull Request 时,请注意以下几点:

  1. 确保你的 Pull Request 是基于 preview 分支, 且为最新。
  2. 保持 PR 足够小,以便每个 PR 只解决一个问题或添加一个功能。
  3. 确保你的 PR 有一个明确的标题和描述,以便 Reviewer 审核。
  4. 请在 PR 中包含适当的描述,并链接相关问题。

PR 标题格式

PR 标题的格式遵循 Conventional Commits 规范。

示例:

1update(contribute): Add `fooBar` config
2^           ^     ^
3|           |     |__ Subject
4|           |_______ Scope (可选)
5|____________ Type