Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 2.33 KB

CIP-TEMPLATE.md

File metadata and controls

39 lines (26 loc) · 2.33 KB
CIP Title Discussions Status Type Author(s) Contributor(s) Created
<to be assigned>
<title is a few words, not a complete sentence>
<URL to Github Issue and/or forum discussion>
Draft
<Meta, Protocol or Tooling & Support>
<a comma separated list of the author's or authors' name + GitHub username (in parenthesis), comp.xyz username and/or name and email (in angle brackets)>
<a comma separated list of contributors to the CIP that make suggestions or editions (formatted the same as the author list)>
<date created on, in ISO 8601 (yyyy-mm-dd) format>

This is the suggested template for new CIPs.

Abstract

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.

Motivation

A motivation section should clearly explain why the existing protocol state is inadequate to address the problem that the CIP solves.

Rationale

The rationale describes what motivated the CIP and why particular design or process decisions were made. It should include alternate designs/processes that were considered and related work, e.g. how the feature/process is implemented in other protocols. The rationale should discuss important objections or concerns raised during discussion around the CIP including technical and legal concerns.

Expected Impact

The CIP's expected impact should list measurable results for how Compound will be improved by its implementation. It might also take note of negative trade-offs mentioned in the Rationale section and demonstrate here that they are outweighed by the positive effects.

Security Considerations (optional)

While not always required for “Meta Process” or “Tooling & Support” CIPs, every “Protocol Enhancement” must contain a section that discusses the security implications/considerations relevant to the proposed change.

Additional Sections (optional)

Additional sections or sub-sections may be added as needed.

Copyright

All CIPs must be in the public domain. The copyright waiver MUST link to the license file and use the following wording:

Copyright and related rights waived via CC0.