Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 2.27 KB

DIP-X.md

File metadata and controls

49 lines (30 loc) · 2.27 KB
DIP title status author shortDescription discussions created updated (*optional) requires (*optional)
<to be assigned>
<DIP title>
WIP
FirstName LastName (@GitHubUsername)
<Short description of DIP>
<Discord Channel or Github issue>
<date created on, in ISO 8601 (yyyy-mm-dd) format>
<date created on, in ISO 8601 (yyyy-mm-dd) format> or N/A
<DIP number(s)>

This is the template for DIPs.

Note that an DIP number will be assigned by an editor. When opening a pull request to submit your DIP, please use an abbreviated title in the filename, DIP-draft_title_abbrev.md.

The title should be 44 characters or less.

Simple Summary

If you can't explain it simply, you don't understand it well enough." Provide a simplified and layman-accessible explanation of the DIP.

Abstract

A short (~200 word) description of the technical issue being addressed.

Motivation

The motivation is critical for DIPs that want to change dYdX. It should clearly explain why the existing protocol specification is inadequate to address the problem that the DIP solves. DIP submissions without sufficient motivation may be rejected outright.

Specification

The technical specification should describe the syntax and semantics of any new feature.

Rationale

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. The rationale may also provide evidence of consensus within the community, and should discuss important objections or concerns raised during discussion.-->

Test Cases

Test cases for an implementation are mandatory for DIPs but can be included with the implementation.

Implementation

The implementations must be completed before any DIP is given status "Implemented", but it need not be completed before the DIP is "Approved". While there is merit to the approach of reaching consensus on the specification and rationale before writing code, the principle of "rough consensus and running code" is still useful when it comes to resolving many discussions of API details.

Copyright

Copyright and related rights waived via CC0.