Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 2.47 KB

Technical-DIP-Template.md

File metadata and controls

62 lines (41 loc) · 2.47 KB

Technical DIP Template

Preamble

DIP#: <--# assigned by DIP Editor -->
Title: <DIP title>
Author(s): <Name of the authoring DGC Member>
Domain: <Ecosystems' Domains it impacts>
Status: <-- assigned by DIP Editor -->
Date Proposed: <yyyy-mm-dd>
Date Ratified: <yyyy-mm-dd>
Dependencies: <List of dependent DIPs>
Replaces: <List of DIP(s) it is replacing>
License: <added by DIP Author>

References

  • A list of supporting materials referenced by this DIP.

Sentence Summary

  • A description of what the Dijets Improvement Proposal (DIP) is focused on. Suggest 30 words max.

Paragraph Summary

  • A description of what the Dijets Improvement Proposal (DIP) is focused on. Suggest 100 words max.

Component Summary

  • A description of the purpose of each module contained within the DIP. Suggest 30 words max per component.

Motivation

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

Specification

Details of the proposed technical solution. The specification should be detailed enough to allow devs to begin its implementation as well as testing. The specification for technical DIPs must include the following modules:

Proposed Code

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

Test Cases

  • For the implementation or testing of the proposed code.

Security Considerations

  • The purpose of this section is to proactively document any security-relevant design information, decisions, potential failure modes, implementation details, and the relevant discussions related to the proposed change(s). This section helps to optimise the DIP process by providing proactive guidance on security considerations when proposing a change that could affect Dijets.

  • Backwards compatibility

Licensing