关于物联网:让每一个来自社区的声音被听见有回响EMQ-X-开源项目正式采用-RFC-流程

7次阅读

共计 2057 个字符,预计需要花费 6 分钟才能阅读完成。

为了使咱们的开源我的项目以更具翻新、更加踊跃的状态高效迭代疾速推动,EMQ X 团队发表,开始正式采纳 RFC 流程,以收集来自社区的意见,继续欠缺产品性能。

RFC(Request For Comments,申请意见稿)是一种为了保障重大个性更新和架构更改可能顺利推动的一种流程机制。

咱们将治理该流程的存储库命名为 EIP,全称为:EMQ X Improvement Proposals。

我的项目地址:https://github.com/emqx/eip

为什么须要 EMQ X EIP

EMQ X 开源我的项目倒退至今,性能愈发弱小,我的项目架构也愈发简单,一些新性能的设计和实现可能会对系统架构和现有性能或多或少产生影响。因而,在布局和实现新性能之前,都须要团队认真探讨和评估。同时,随着用户和社区群体的增长壮大,咱们也收到了来自越来越多用户针对 EMQ X 所提出的充斥翻新的优良功能设计倡议,以及把这些想法融入到 EMQ X 将来版本中的志愿。

因而,EIP 我的项目应运而生。咱们将为大家提供一个平台,用于记录想法、设计或实现新性能的详细信息。当有一些想法或者更新会波及到零碎架构、性能、API 的变更等——如上文所述,都须要在开发工作开始前通过一个探讨与审核流程,此时 EIP 将是一个更适合的路径来保障 EMQ X 团队与社区用户达成共识。

EIP 具备以下三个个性:

  • 凋谢翻新合作。EMQ X 是一个开源我的项目,咱们遵循开源我的项目准则——不仅放弃源码的凋谢,对于功能设计与探讨也将凋谢进去,使 EMQ X 与社区用户更加严密的分割起来。人人都可参加,人人都可理解。通过更多参与者帮忙、领导和欠缺 EMQ X 的设计,让更多具备创造力的想法得以顺利落地。
  • 保障我的项目稳定性。EIP 能让咱们尽可能升高每次迭代对老用户的影响,所纳入的想法倡议和设计都将通过认真的审核与探讨,最大水平保障每一个性能的输出都牢靠且稳固,为大家提供最佳的应用体验。
  • 追踪设计。通过 EIP,每个性能的想法和设计都将蕴含一个 PR 和探讨记录。当咱们对一项性能个性进行了新增、勾销或批改,咱们心愿用户能够通过每一个 EIP 文档和背地的 PR 看到咱们对此所作的思考与斗争。这对于 EMQ X 长期的倒退和想要深刻理解 EMQ X 的开发者来说都十分重要。

此外,小局部的个性性能更新、Bug 修复的代码变更依然能够遵循一般的 GitHub 流程,通过提交 Issue,发动 Pull Request 和 Code Review 来实现。

如何应用 EMQ X EIP

所有的 EIP 均为 Markdown(* .md)格式文件。

新的 EIP 首先应通过创立新的 Pull Request,通过探讨批准后进入 active 目录。设计并实现该性能后,会将其放入 implemented 的目录中。

提交 EIP 之前,请浏览 0000-proposal-template,这是一个演示 EIP 格局的模板,大抵构造如下:

# An Example of EMQ X Improvement Proposal

## Change log

* 2020-10-21: @emqxplus Initial draft
* 2020-02-05: @terry-xiaoyu Restructure
* 2021-02-21: @zmstone Add 'Declined Alternatives' section

用于记录批改信息,蕴含批改的日期,作者,和批改内容

## Abstract

对要解决的技术问题的简短形容(约 200 字)。## Motivation

此处应分明地解释为什么此 EIP 倡议的性能是必要的。没有足够动机的 EIP 提交可能会被齐全回绝。## Design

此处应详细描述性能的设计。如果对体系结构进行了更改,则可能须要一些图表。## Configuration Changes

此处应列出对配置文件的所有更改(如果有的话)。## Backwards Compatibility

此处应阐明如何使此性能向后兼容。如果它与以前的 emqx 版本不兼容,请解释和倡议如何解决不兼容问题。## Document Changes

如果文档有任何更改,请在此处简要阐明。## Testing Suggestions

最终实现必须包含单元测试或通用测试代码。如果须要手动进行更多测试,例如集成测试或基准测试,请在此处列出。## Declined Alternatives

这里探讨有哪些代替计划,但被认为比以后的计划更差一些。这是为了帮忙人们理解咱们如何达到以后状态,避免再次进行探讨。

您也能够参考在 implemented 中的 EIP 文档。通过已实现的实例参考来编辑您须要提供的想法和倡议的文档。

开始你的第一个 EMQ X EIP

至此,咱们欢送各位读者、用户和开发者们积极参与到 EIP 我的项目中来,为 EMQ X 提供更多新鲜和弱小的性能倡议与想法。

联合 EMQ X EIP,让每一个声音被听到、有回响,使 EMQ X 成为所有社区用户为之骄傲的开源我的项目,一个 IoT 时代平凡的开源我的项目将由咱们独特发明。

版权申明:本文为 EMQ 原创,转载请注明出处。

原文链接:https://www.emqx.cn/blog/emqx-rfc

正文完
 0