如何贡献
Apache RocketMQ —— 开放、共享的开源社区,诚挚邀请您的加入。
社区沟通与贡献方式
- 提问
- 提交错误报告
- 引入新功能
- 参与邮件列表讨论
- 贡献代码或文档
- 优化网站
- 测试预发布版本
请求解答问题
Apache RocketMQ 社区提供了完善的流程来帮助您解答疑惑。
您可以通过 用户邮件列表 和 Stack Overflow #rocketmq 进行提问。
提交错误报告
如果您在使用 RocketMQ 时遇到问题,可以在 GitHub Issue 上提交错误报告。
提议改进或新功能
社区一直在寻求反馈以改进 Apache RocketMQ,您对改进或新功能的需求将造福所有 RocketMQ 用户,请在 GitHub Issue 上创建一个 Issue。
提案需要包含适当的细节和影响范围。请尽可能详尽地阐述需求。我们希望获得更完整的信息,原因如下:
- 所实现的改进和新功能最终符合您的需求
- 评估投入成本并根据您的需求设计解决方案
- 促进围绕该提案的建设性社区讨论
如果您计划实现您的提案以回馈社区,您还需要提供详细的描述信息,并遵循 代码规范 (code-guidelines)。
我们建议在实施功能之前先建立社区共识。通过讨论新功能的必要性及实现方式,可以尽早发现超出项目范围的提案。
参与讨论并帮助他人
Apache RocketMQ 社区成员通过以下两种类型的邮件列表进行沟通:
用户邮件列表 :Apache RocketMQ 用户使用该列表寻求帮助或建议。
您可以通过订阅邮件系统帮助他人解决问题,从而为社区做出贡献;
您也可以在 Stackoverflow 上搜索 rocketmq 标签,回答用户的问题并获得更多见解。
开发邮件列表 :Apache RocketMQ 开发者使用该列表交流新功能、预发布版本、一般开发流程等。
如果您有兴趣为 RocketMQ 社区贡献代码,可以加入该邮件列表。
您还可以通过订阅 邮件列表 获取关于社区的更多信息。
测试预发布版本
Apache RocketMQ 在活跃社区的帮助下不断成长。我们每隔几周就会发布一个 RocketMQ 新版本,以修复 Bug、提升性能、增加功能等。发布新版本的流程如下:
- 发起一个新的预发布版本并启动投票流程(72 小时)
- 测试预发布版本并进行评分(+1 表示未发现问题,-1 表示存在测试问题)
- 如果预发布版本测试通过则正式发布;否则,返回第一步
我们已在网站上编制了 发布手册 (release-manual)。测试预发布版本是一项庞大的工作,我们需要更多人的参与。RocketMQ 社区鼓励每个人参与新版本的测试。通过测试预发布版本,您将确信新的 RocketMQ 版本能够正常服务于您的程序,并确实支持版本升级。
贡献代码
Apache RocketMQ 过去、现在及未来都将持续进行维护、优化和扩展。因此,Apache RocketMQ 鼓励每个人贡献源代码。为了给代码贡献者和审核者提供优秀的贡献体验并维护高质量的代码库,社区遵循 代码规范 (code-guidelines) 中的贡献流程。该手册包含了构建开发环境的指南、社区编码规范和代码风格,并说明了如何提交贡献的代码。
**在编码前请务必仔细阅读 代码规范
并请阅读 Apache 软件基金会贡献者许可协议 以提交电子签名。
如何找到合适的 Issue?
GitHub Issue 列出了目前已提出的改进和建议的功能。
贡献文档
优秀的文档对任何软件都至关重要。Apache RocketMQ 社区致力于提供简洁、准确且完整的技术文档。社区欢迎所有贡献,以帮助完善和改进 RocketMQ 文档。
- 请在 GitHub Issue 上报告缺失、错误或过期的文档。
- RocketMQ 技术文档以 Markdown 形式编写,存储在 RocketMQ 官网仓库 的
/docs目录下。
阅读 问答 (Q&A) 以了解如何通过更新和优化文档进行贡献。
优化网站
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 社区的重要组成部分。
毫无疑问,为项目贡献代码和文档同样重要。一个好的开始是进行性能优化、开发新功能和修复 Bug。无论哪种方式,您都有责任贡献代码、提供测试用例和文档,并持续进行维护。
候选人可以由社区中的 Committer 或 PMC 成员推荐,并最终由 PMC 投票通过。
如果您有兴趣成为 RocketMQ 社区的 Committer,请积极参与社区活动,并通过上述任何方式为 Apache RocketMQ 做出贡献。
社区中的 Committer 成员将非常乐意与您分享经验,并酌情为您提供建议和指导。