This is a template for a filed proposal. Create a pull request using this template.

Title

This is the title of the POEM. A good simple title would help to describe the purpose of a proposal.

Your Poem

Roses are red. Violets are blue. Your ideas are beautiful. We welcome you.

Status

  • Current state: (Draft | In-progress | Completed | Abandoned)
  • Author(s): @author (Github ID)

Summary and Motivation

This section summarize the proposal. A brief description, proposed changes, and effects are expected to be included. You should cover the “what” and the “why” and briefly the “how”.

Proposed changes: Architecture Diagram (optional), and Design

This section may include large subsections, diagrams, links to references, and so on.

It is recommended to include an architectural diagram. A link to an external resource is enough.

Implementation details

This section describe how to implement the proposal.

Issue (optional)

Any issue(compatibility, drawbacks, etc) should be describe here.

Integration and Migration plan (optional)

If a proposal contains any breaking changes, it is required to include a plan for integration and migration.