---
mip: <to be assigned>
title: <MIP title>
author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <[email protected]>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
discussions-to: <URL>
status: Draft
type: <Standards Track, Meta, or Informational>
category (*only required for Standards Track): <Core, Networking, Interface, or ERC>
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
requires (*optional): <MIP number(s)>
replaces (*optional): <MIP number(s)>
---
This is the suggested template for new MIPs.
Note that an MIP number will be assigned by an author. When opening a pull request to submit your MIP, please use an abbreviated title in the filename, xxxx-<description>.md.
The title should be 44 characters or less.
If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the MIP. Imagine an email subject line, GitHub PR title, or forum post title.
A short (~200 word) description of the technical issue being addressed. This should be a very terse and human-readable version of the specification section. Someone should be able to read only the abstract to get the gist of what this specification does.
The motivation section should describe the "why" of this MIP. What problem does it solve? Why should someone want to implement this standard? What benefit does it provide to the Mainflux ecosystem? What use cases does this MIP address?
The technical specification should describe the syntax and semantics of any new feature. The specification should be detailed enough to allow complete implementation for Mainflux platform.
The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages.
All MIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The MIP must explain how the author proposes to deal with these incompatibilities. MIP submissions without a sufficient backwards compatibility treatise may be rejected outright.
Test cases for an implementation are mandatory for MIPs that are affecting consensus changes. Other MIPs can choose to include links to test cases if applicable.
An optional section that contains a reference/example implementation that people can use to assist in understanding or implementing this specification. If the implementation is too large to reasonably be included inline, then consider adding it as one or more files in ../assets/mip-####/.
All MIPs must contain a section that discusses the security implications/considerations relevant to the proposed change. Include information that might be important for security discussions, surfaces risks and can be used throughout the life cycle of the proposal. E.g. include security-relevant design decisions, concerns, important discussions, implementation-specific guidance and pitfalls, an outline of threats and risks and how they are being addressed. MIP submissions missing the "Security Considerations" section will be rejected. An MIP cannot proceed to status "Final" without a Security Considerations discussion deemed sufficient by the reviewers.
Copyright and related rights waived via CC0.