Technical MIP Template

July 5, 2021 ยท View on GitHub

Preamble

MIP#: <# to be assigned>
Title: <MIP title>
Author(s): <list of authors' names and/or email addresses and GitHub handles>
Contributors: <list of contributor's names and/or email addresses and GitHub handles>
Tags: template
Type: MIP Type
Status: <Assigned by MIP Editor>
Date Proposed: <yyyy-mm-dd>
Date Ratified: <yyyy-mm-dd>
Dependencies: <List of dependent MIPs>
Replaces: <List of MIP it is replacing>
License: <added by MIP Author>

References

  • A list of supporting materials referenced by this MIP.

Sentence Summary

  • A description of what the Maker Improvement Proposal (MIP) is focused on. Suggest 30 words max.

Paragraph Summary

  • A description of what the Maker Improvement Proposal (MIP) is focused on. Suggest 100 words max.

Component Summary

  • A description of the purpose of each component in the MIP. Suggest 30 words max per component.

Motivation

  • A short description of the motivation behind the proposed technical solution.

Specification

The details of the proposed technical solution. The specification should be detailed enough to allow an implementation team to begin development as well as testing. The specification for technical MIPs must include the following components:

Proposed Code

  • The final code that can be used directly in the executive vote to accept or reject the MIP.

Test Cases

  • For the implementation or testing of the proposed code

Security Considerations

  • This is one of the most important aspects of the Technical MIP proposal. The purpose of this section is to proactively document any security-relevant design information, decisions, potential failure modes, implementation details, and important discussions related to the proposed change. This section helps to optimize the MIP process by providing proactive guidance on security considerations when proposing a change that will affect the Maker Protocol.
  • Backwards compatibility

Auditor Information and Report

  • This section includes the audit partner details and the final audit report for the proposed code.

Licensing