Browse Source

Create template.md

Benjamin Ansbach 5 years ago
parent
commit
132194d69c
1 changed files with 33 additions and 0 deletions
  1. 33 0
      PIP/resources/PIP-0037/template.md

+ 33 - 0
PIP/resources/PIP-0037/template.md

@@ -0,0 +1,33 @@
+# Protocol Specification
+
+## Summary
+
+Short (~200 word) description of the protocol specification.
+
+## Version history:
+
+- [Link to version](Version number)
+
+## Motivation
+
+Clear explanation of why your protocol specification is needed.
+
+## Specification
+
+Full technical description of the proposed protocol. Should contain everything for a developer to implement the protocol in combination with the reference implementation.
+
+## Upgrade Guide
+
+In case of a version change and fundamental changes, list your advisories here.
+
+## Reference implementation
+
+Add at least one reference implementation. It needs to be Open Source.
+
+| Name | Version | Link |
+| ---- | ------- | ---- |
+|      |         |      |
+
+## Other
+
+Add whatever you would like to add.