Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 1.96 KB

ipip-template.md

File metadata and controls

72 lines (47 loc) · 1.96 KB
title date ipip editors relatedIssues order tags
IPIP-0000: InterPlanetary Improvement Proposal Template
YYYY-MM-DD
proposal
name
Your Name
link to issue
0
ipips

Summary

This is the suggested template for new IPIPs.

Motivation

AKA Problem Statement

Clearly explain why the existing protocol specification is inadequate to address the problem that the IPIP solves.

Detailed design

AKA Solution Proposal

Describe the proposed solution and list all changes made to the specs repository.

The resulting specification should be detailed enough to allow competing, interoperable implementations.

When modifying an existing specification file, this section should provide a summary of changes. When adding new specification files, list all of them.

Design rationale

The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made.

Provide evidence of rough consensus and working code within the community, and discuss important objections or concerns raised during discussion.

User benefit

How will end users benefit from this work?

Compatibility

Explain the upgrade considerations for existing implementations.

Security

Explain the security implications/considerations relevant to the proposed change.

Alternatives

Describe alternate designs that were considered and related work.

Test fixtures

List relevant CIDs. Describe how implementations can use them to determine specification compliance. This section can be skipped if IPIP does not deal with the way IPFS handles content-addressed data, or the modified specification file already includes this information.

Copyright

Copyright and related rights waived via CC0.