Skip to content

Latest commit

 

History

History
57 lines (40 loc) · 2.27 KB

Technical-MIP-Template.md

File metadata and controls

57 lines (40 loc) · 2.27 KB
Raw

Technical MIP Template

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
Category: Binding (Executable Purely On-Chain) vs. Signaling (Non-Binding Social Consensus Signal)
Status: <Assigned by MIP Editor>
Date Proposed: <yyyy-mm-dd>
Date Ratified: <yyyy-mm-dd>
Dependencies: <List of dependent MIPs if applicable>
Replaces: <List of MIP it is replacing if applicable>
License: <Added by MIP Author>

References

  • A list of supporting materials referenced by this MIP.

Summary

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

Abstract

  • A 3-5 sentence description of the full MIP going through the problem it solves, how it's solved and by whom and how it will be implemented.

Motivation

  • A short description of the motivation behind the MIP.

Specification

  • Proposed process standard details - describes the new process or feature and the problem it is solving.

Proposed Code

  • The final code that can be used directly in the Martian Council 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 Mars Protocol.

Auditor Information and Report

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

Licensing

  • Recommended licenses for developed code:
    • MIT: Expat/MIT/X11 license
    • BSD-2-Clause: OSI-approved BSD 2-clause license
    • BSD-3-Clause: OSI-approved BSD 3-clause license
    • CC0-1.0: Creative Commons CC0 1.0 Universal
    • GNU-All-Permissive: GNU All-Permissive License
    • Apache-2.0: Apache License, version 2.0