Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.5 KB

0000-proposal-template.md

File metadata and controls

50 lines (31 loc) · 1.5 KB

An Example of EMQ X Improvement Proposal

Changelog

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

Abstract

A short (~200 word) description of the technical issue being addressed.

Motivation

This section should clearly explain why the functionality proposed by this EIP is necessary. EIP submissions without sufficient motivation may be rejected outright.

Design

This section should describe the design of the feature in detail. If it is a change to the architecture, some diagrams may be necessary.

Configuration Changes

This section should list all the changes to the configuration files (if any).

Backwards Compatibility

This sections should shows how to make the feature is backwards compatible. If it can not be compatible with the previous emqx versions, explain how do you propose to deal with the incompatibilities.

Document Changes

If there is any document change, give a brief description of it here.

Testing Suggestions

The final implementation must include unit test or common test code. If some more tests such as integration test or benchmarking test that need to be done manually, list them here.

Declined Alternatives

Here goes which alternatives were discussed but considered worse than the current. It's to help people understand how we reached the current state and also to prevent going through the discussion again when an old alternative is brought up again in the future.