| Author | Dmitry Gubanov <dgubanov@wavesplatform.com> |
|---|---|
| Last update | 2019-05-23 |
Abstract
We suggest introducing a unified structure for proposals with the aim of increasing readability and convenience of creating documents. Waves Enhancement Proposal(WEP) outlines information about a suggested innovation in the Waves ecosystem.
To ensure the proposal is accepted, the WEP’s author must build consensus within the community.
Motivation and Purposes
The Waves community is very active, and members often come up with good ideas for improving the platform. However, at this moment there is no concrete place where authors can publish their proposals as well as there are no recommendations for their compilation.
The purpose of this document is to recommend a unified format and the place for publication of proposals.
Specification
The following structure is suggested:
- Title – name in format «WEP №: title description», with information about the author and the last WEP update below.
- Abstract – simple, brief description of the main idea.
- Motivation and Purposes – description of what prompted the proposal and the author’s intended goals.
- Specification – technical description of the implementation.
- Rationale - explaining why this approach was chosen as a means to solve the problem.
- Backwards Compatibility – compatibility of changes with the currentversion.
- *Examples and Implementation – optional, but desirable examples and possible code implementation.
A special category on the Waves forum is suggested as a location for proposals.
The life cycle of any proposal can be represented as follows:
- Writing the WEP according to the recommended structure.
- Posting the WEP text on the forum in the Proposal category.
- After discussion, a decision is made on whether the proposed innovations should be implemented.
- The proposed innovation is included in the next release.
- Nodes vote to accept or reject the proposed changes.
Rationale
In this implementation the preliminary review stage for proposals has intentionally been omitted, in order to simplify the publication process. For the same reason, the recommended structure of the document includes only the most important points.
Backwards Compatibility
The above innovations don’t affect the backward compatibility of the platform.
Examples and Implementation
This proposal may serve as an example for subsequent proposals.
