Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 3.78 KB

MIP-Template.md

File metadata and controls

70 lines (48 loc) · 3.78 KB
mip title status stability discussions-to type created
x
MIP Title
Draft
n/a
Community
2023-04-28

Note

Rename this file to mip-x.md in your proposal. If more than one MIP will be submitted, then a suffix can be added to each file as mip-x-foo.md, mip-x-bar.md, etc. MIP numbering will automatically be applied with renamed filenames when merged.

["Status" should be one of: Draft | Review | Last Call | Accepted | Implemented | Postponed | Declined | Discontinued]

["Stability" describes the stability of the implementation. Prior to implementation it should be left as "n/a". Once implemented, the stability will be one of: Experimental | Stable | Deprecated]

["Author(s)" should have a comma-separated list of the MIP authors. Each author MUST be written in the following format: Name Surname <email> (@github-username). If the author wants to maintain anonymity, they MAY provide only the username instead of their name and surname. The e-mail and github username are optional and MAY be provided. At least one of the authors MUST have a Github username provided in order to be notified of the changes concerning their MIP.]

["Type" should either be "Community" or "Maintainer". If you are not an API Maintainer, then please use "Community". You can learn more about the distinction between these types in the Process Guide.]

Summary

[Brief summary of the proposal]

Motivation

[Explain why this proposal is necessary and what impact it would have for the developer ecosystem. What problem does it solve? What alternatives were considered (ex. extending via a Snap)? Why is this proposal preferred over alternative solutions or work-arounds?]

Usage Example

[Provide an illustrative example of the proposed API or feature in use]

Proposal

Language

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" written in uppercase in this document are to be interpreted as described in RFC 2119.

Definitions

[Provide detailed definitions for any new terms or concepts introduced in the proposal]

Proposal Specification

[Provide a detailed description of the proposed changes, including any relevant technical specifications or examples]

[Include a reference to the OpenRPC specification for any JSON-RPC APIs being proposed - this should be done by opening a PR on the api-specs repository]

Caveats

[List any potential drawbacks, limitations, or risks associated with the proposal]

Implementation

[Outline how the proposal will be implemented. Which party is expected to implement the proposal?]

Developer Adoption Considerations

[Explain any considerations that developers should take into account when adopting this proposal. For example, how will it affect compatibility, and what changes may need to be made to accommodate the proposal?]

User Experience Considerations

[Explain any user experience implications of the proposal]

Security Considerations

[Explain any potential security implications of the proposal]

References

[List any relevant resources, documentation, or prior art]

Feedback

[Provide a way for interested parties to give feedback or make suggestions, such as a GitHub issue or discussion thread]

Committed Developers

[List the names of developers who have committed to using this proposal in an experimental state. This will help gauge community interest and adoption.]

Note: This proposal template is meant to be adapted for different contexts and may require additional sections or information depending on the specific proposal.

Copyright

Copyright and related rights waived via CC0.