A general guide to follow, which include templates, markdown standards and the governance model required to select editors and modify processes, approve or do changes might also require editor and DAO revision. The goal is to have quality Maxcoin Improvement Proposals.
The goal is to provide the Maxcoin Improvement Proposals Guideline
MIP format and structure template
MIPs should be written in markdown format. Based on our Maxcoin site markdown
|MIP||to be assigned|
|title||The MIP title is a few words, not a complete sentence|
|description||Description is one full (short) sentence|
|author||a comma separated list of the author’s or authors’ name + GitHub username (in parenthesis), or name and email (in angle brackets). Example, FirstName LastName (@GitHubUsername), FirstName LastName email@example.com, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)|
|type||Standards Track, Meta, or Informational|
|created||date created on, in ISO 8601 (yyyy-mm-dd) format|
|requires (optional)||MIP number(s)|
This is the suggested template for new MIPs.
Note that an MIP number will be assigned by an editor. When opening a pull request to submit your MIP, please use an abbreviated title in the filename,
The title should be 44 characters or less. It should not repeat the MIP number in title, irrespective of the category.
Abstract is a multi-sentence (short paragraph) technical summary. 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 Maxcoin Project? What use cases does this MIP address?
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
The technical specification should describe the syntax and semantics of any new feature.
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. If the test suite is too large to reasonably be included inline, then consider adding it as one or more files in
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
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 EIP cannot proceed to status “Final” without a Security Considerations discussion deemed sufficient by the reviewers.
Change logs date created on, in ISO 8601 (yyyy-mm-dd) format and a comment of changes
TBA : Requires a compatible freeware version or FOSS based ones
TBA: requires the Governance model
TBA: requires the Governance model
|2021-12-15||first draft for MIP1 - Purpose and Guidelines|