Skip to content

Commit

Permalink
update dip template
Browse files Browse the repository at this point in the history
  • Loading branch information
fed-franz committed Jan 9, 2025
1 parent d61e02c commit 36c3f33
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions data/dip-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,33 @@
---

## Abstract
A concise technical summary of the proposal.
<!-- A concise technical summary of the proposal. -->

## Motivation
Describes the issue being addressed and why the proposal is necessary.
<!-- Describes the issue being addressed and why the proposal is necessary. -->

## Technical Specification
Detailed description of the proposed changes, including protocol changes, data structures, API alterations, and cryptographic considerations.
<!-- Detailed description of the proposed changes, including protocol changes, data structures, API alterations, and cryptographic considerations. -->

## Rationale
Discussion on the decision-making process and trade-offs considered.
<!-- Discussion on the decision-making process and trade-offs considered. -->

## Backwards Compatibility
Analysis of how the proposal interacts with existing features or might affect backward compatibility.
<!-- Analysis of how the proposal interacts with existing features or might affect backward compatibility. -->

## Test Cases
Practical examples and test cases for validating the proposed changes.
<!-- Practical examples and test cases for validating the proposed changes. -->

## Implementation
Reference to the implementation code; this may include links to PRs in external repositories.
<!-- Reference to the implementation code; this may include links to PRs in external repositories. -->

## Security Considerations
Assessment of potential security implications and how they are addressed.
<!-- Assessment of potential security implications and how they are addressed. -->

## References
Links to any related documents, discussions, or other relevant materials.
<!-- Links to any related documents, discussions, or other relevant materials. -->

## Updates (Optional)
Documenting significant changes or updates to the proposal post-acceptance.
---

## Updates
<!-- Documenting significant changes or updates to the proposal post-acceptance. -->

0 comments on commit 36c3f33

Please sign in to comment.