跳至主要內容

贡献指南

大约 2 分钟

我们欢迎为 AirMCU 项目做出任何贡献!

如何贡献

欢迎对 AirMCU 做出贡献(修复错误、添加功能、添加文档)。我们通过 Github Pull Requests (后文中我们将其称之为“PR”) 接受贡献。

前置要求

在向我们发送 PR 请求之前,请考虑以下事项:

  • 该贡献完全是您自己的作品吗?还是已经根据 LGPL 2.1 兼容的开源许可证获得了许可?如果没有,那我们将无法接受。

  • 代码是否有足够的注释并且人们可以理解它的结构吗?

  • 是否有与代码贡献相关的文档或示例?

  • 注释和文档是否用清晰的英语或者中文编写,没有拼写或语法错误?

  • 也欢迎提供示例贡献。

  • 如果贡献包含多个提交,它们是否被归类为逻辑变更(每个拉取请求一个主要变更)?是否有名称为“修正了拼写错误”的提交被挤压到之前的提交open in new window中?

如果您对上述任何一点不确定,都可以开启一个新的PR,然后向我们寻求帮助。

PR 请求流程

打开 PR 后,请求本身的注释栏中可能会有一些讨论。

一旦拉取请求准备好合并,它将首先被合并到我们的内部 git 系统中进行 "内部 "自动测试。

如果测试通过,它将被合并到 GitHub 公共仓库。

贡献流程

如果是有关 AirMCU 文档open in new window部分,请参考文档贡献指南

如果是有关核心库open in new window部分,请参考下面的流程:<>