Skip to content

Latest commit

聽

History

History
54 lines (34 loc) 路 2.12 KB

template-technical-dip.md

File metadata and controls

54 lines (34 loc) 路 2.12 KB
Raw
DIP: <# to be assigned>
Title: <DIP title>
Author(s): <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 <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>
Contributors:
Type: DIP Type
Status: <Assigned by DIP Editor>
Date Proposed: <date created on, in ISO 8601 (yyyy-mm-dd) format>
Date Ratified: <date created on, in ISO 8601 (yyyy-mm-dd) format>
Dependencies: <DIP number(s)>
Replaces: <DIP number(s)>
License: <added by DIP Author>

References

  • A list of supporting materials referenced by this DIP.

Sentence Summary

  • A description of what the DIP is focused on. Suggest 30 words max.

Paragraph Summary

  • A description of what the DIP is focused on. Suggest 100 words max.

Component Summary

  • A description of the purpose of each component in the DIP . Suggest 30 words max per component.

Motivation

  • A short description of the motivation behind the proposed technical solution.

Specification

The details of the proposed technical solution. The specification should be detailed enough to allow an implementation team to begin development as well as testing. The specification for technical DIPs must include the following components:

Proposed Code

  • The final code that can be used directly in the executive vote to accept or reject the DIP.

Test Cases

  • For the implementation or testing of the proposed code

Security Considerations

  • This is one of the most important aspects of the Technical DIP proposal. The purpose of this section is to proactively document any security-relevant design information, decisions, potential failure modes, implementation details, and important discussions related to the proposed change. This section helps to optimize the DIP process by providing proactive guidance on security considerations when proposing a change that will affect the Dev Protocol.
  • Backwards compatibility

Copyright

Copyright and related rights waived via CC0.