跳过到主要内容
版本: 5.0

如何贡献

Apache RocketMQ —— 开放、共享的开源社区，诚挚邀请您的加入。

社区交流与贡献方式

  • 提问
  • 提交错误报告
  • 提出新功能
  • 参与邮件列表讨论
  • 贡献代码或文档
  • 优化网站
  • 测试预发布版本

提问​

Apache RocketMQ 社区提供了一套完整的流程来帮助您解答问题。

您可以通过用户邮件列表和Stack Overflow #rocketmq提问。

提交错误报告​

如果您在使用 RocketMQ 时遇到问题，可以在GitHub Issue上提交错误报告。

提出改进或新功能​

社区一直在寻求反馈以改进 Apache RocketMQ，您对改进或新功能的需求将使所有 RocketMQ 用户受益，请在GitHub Issue上创建议题。

提案需要包含适当的细节和影响范围。请尽可能详细地阐述需求。我们希望获得更完整的信息，原因如下：

  • 实现的改进和新功能最终符合您的需求
  • 根据您的需求评估投入成本并设计解决方案
  • 促进围绕提案的建设性社区讨论

如果您计划实现您的提案并贡献给社区，您还需要提供详细的描述信息，并遵循代码规范。

我们建议在实现功能之前建立社区共识。通过讨论新功能的需求和如何实现它们，可以尽早发现超出项目范围的提案。

参与讨论并帮助他人​

Apache RocketMQ 社区成员通过以下两种类型的邮件进行交流：

  • 用户邮件列表：Apache RocketMQ 用户使用此邮件列表寻求帮助或建议。

    您可以通过订阅邮件系统来帮助他人解决问题，从而为社区做出贡献；

    您也可以在 Stackoverflow 上检索rocketmq标签，回答用户问题并获得更多见解。

  • 开发邮件列表：Apache RocketMQ 开发者使用此邮件列表来交流新功能、预发布版本、一般开发流程等。

    如果您有兴趣向 RocketMQ 社区贡献代码，可以加入此邮件列表。

您也可以通过订阅邮件列表获取更多社区信息。

测试预发布版本​

在活跃社区的帮助下，Apache RocketMQ 不断成长。每隔几周，我们都会发布 RocketMQ 的新版本，以修复错误、提高性能、增加功能等。发布新版本的流程如下：

  1. 发布新的预发布版本并启动投票流程（72小时）
  2. 测试预发布版本并打分（+1 未发现问题，-1 测试问题）
  3. 如果预发布版本通过测试，则发布；否则，返回步骤1。

我们已经在网站上编制了发布手册。测试预发布版本是一项繁重的工作，我们需要更多人参与。RocketMQ 社区鼓励所有人参与新版本的测试。通过测试预发布版本，您将确信新的 RocketMQ 版本仍能正常服务您的程序，并且确实支持版本升级。

贡献代码​

Apache RocketMQ 已经并将继续得到维护、优化和扩展。因此，Apache RocketMQ 鼓励所有人贡献源代码。为了给代码贡献者和审查者提供良好的代码贡献体验并提供高质量的代码仓库，社区遵循代码规范中的贡献流程。该编码手册包含构建开发环境、社区编码规范和编码风格的指南，并描述了如何提交贡献代码。

**请务必在编码前仔细阅读代码规范**

并请阅读Apache 软件基金会贡献者许可协议以提交电子签名。

如何找到合适的议题？

GitHub Issue列出了迄今为止已提出建议的改进和功能。

文档贡献​

良好的文档对任何软件都至关重要。Apache RocketMQ 社区致力于提供简洁、准确、完整的技术文档。社区邀请所有贡献者帮助完善和改进 RocketMQ 文档。

  • 请在GitHub Issue上报告缺失、不正确或过期的文档。
  • RocketMQ 技术文档以 Markdown 格式编写，并存储在RocketMQ 官网仓库的/docs目录下。

阅读问答了解如何通过更新和完善文档来贡献。

优化网站​

Apache RocketMQ 网站代表着 Apache RocketMQ 和 Apache RocketMQ 社区。其主要功能如下：

  • 让访问者熟悉 Apache RocketMQ 及其功能
  • 支持访问者下载和使用 RocketMQ
  • 引导访问者参与和贡献 RocketMQ 社区

社区接受任何有助于改进网站的贡献。

请通过创建GitHub Issue提出您对网站的建议和想法。

如果您想更新或优化网站，请访问apache/rocketmq-site new-official-website

更多贡献方式...​

您还可以选择更多方式为 RocketMQ 社区做出贡献：

  • 向尽可能多的合作伙伴介绍 RocketMQ
  • 组织线下交流会议或线上用户组
  • 成为 RocketMQ 的布道师
  • ...

如何成为 Committer​

Committer 是社区项目仓库的成员，可以修改代码、文档和网站，或接受其他成员的贡献。

成为 Committer 没有严格的协议，候选人通常是社区中的活跃贡献者。

作为活跃贡献者意味着：参与邮件列表讨论、帮助他人解决问题、验证预发布版本、表彰优秀人员并持续优化社区管理，这些都是 Apache 社区的一部分。

毫无疑问，向项目贡献代码和文档同样重要。一个好的开始是优化性能、开发新功能和修复错误。无论哪种方式，您都将负责贡献代码、提供测试用例和文档，并持续维护。

候选人可以由社区中的 Committer 或 PMC 成员推荐，最终由 PMC 投票决定。

如果您有兴趣成为 RocketMQ 社区的 Committer，请积极参与社区并以上述任何方式为 Apache RocketMQ 做出贡献。

社区中的 Committer 成员将乐于与您分享并酌情提供建议和指导。