Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.25 KB

cip-template.md

File metadata and controls

48 lines (35 loc) · 2.25 KB
Error in user YAML: (<unknown>): mapping values are not allowed in this context at line 3 column 152
---
cip: <to be assigned>
title: <CIP 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-url: <URL>
created: <date created on, in ISO 8601 (yyyy-mm-dd) format>
---

This is the suggested template for new CIPs. Note that a CIP number will be assigned by a core dev.

One-Line Description

A very simple description that someone who's quickly scanning CIPs can use to immediately understand what this change is doing.

Explanation and Motivation

Provide a simple explanation of the CIP.

Include an explanation of the "why" behind this CIP. What problem does it solve?

Specification

The technical specification should describe the new feature in deep technical detail. It should be detailed enough to allow for complete implementation.

Include the rationale behind any decisions. If there were any approaches that didn't work, feel free to explain them to help future devs understand why things are the way they are.

Backwards Compatibility

All CIPs that introduce backwards incompatibilities must include a section describing these incompatibilities and their severity. The CIP must explain how the author proposes to deal with these incompatibilities.

Test Cases

If this change requires more than just unit tests, include an explanation of how you're going to test your change to make sure it works.

Security Considerations

All CIPs must contain a section that discusses the security implications/considerations relevant to the proposed change. Include possible attack vectors or ways this change could cause problems down the road.

Alternate designs considered

Provide a list of other ideas that you considered and their pros and cons. This will help community understand the constraints under which other ideas were not chosen.

Data Storage Change

Identify the additional storage requirement in the blockchain due to this change.

Acknowledgements

If there were additional community members that helped you guide / hone your thoughts, or members whose feedback was constructive to make this CIP better.