From b0d6b2c94d6f97f079f084206b5819056b4f021c Mon Sep 17 00:00:00 2001
From: Marcin Rataj <lidel@lidel.org>
Date: Fri, 8 Jul 2022 21:28:05 +0200
Subject: [PATCH] ipip: add spec template.md

https://github.com/ipfs/specs/pull/289#discussion_r901688607
---
 ...ightweight-improvement-proposal-process.md |  5 +-
 template.md                                   | 52 +++++++++++++++++++
 2 files changed, 55 insertions(+), 2 deletions(-)
 create mode 100644 template.md

diff --git a/IPIP/0001-lightweight-improvement-proposal-process.md b/IPIP/0001-lightweight-improvement-proposal-process.md
index 64fb2844..0ec67849 100644
--- a/IPIP/0001-lightweight-improvement-proposal-process.md
+++ b/IPIP/0001-lightweight-improvement-proposal-process.md
@@ -49,9 +49,10 @@ Changes to IPFS specifications can be proposed by opening a Git pull-request
 (PR) against the `ipfs/specs` repository.
 
 In addition to specification changes, such PR must include a short **IPIP
-document** based on the template in `ipfs/specs/IPIP/0000-template.md`.
+document** based on the template in [`ipfs/specs/IPIP/0000-template.md`](./0000-template.md).
 
-When a new specification is added, `ipfs/specs/template.md` can be used.
+When a new specification file is added to the repo, it should be based on
+the template at [`ipfs/specs/template.md`](../template.md).
 
 ### Reviewing IPIPs
 
diff --git a/template.md b/template.md
new file mode 100644
index 00000000..f568d21c
--- /dev/null
+++ b/template.md
@@ -0,0 +1,52 @@
+# Specification Template
+
+![wip](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square)
+
+**Author(s)**:
+- Name
+
+**Maintainer(s)**:
+- Name
+
+* * *
+
+**Abstract**
+
+One paragraph explanation of the specification
+
+## Organization of this document
+
+- [Introduction](#introduction)
+- [Specification](#specification)
+  - [Test fixtures](#test-fixtures)
+  - [Security](#security)
+  - [Privacy and User Control](#privacy-and-user-control)
+
+## Introduction
+
+Clearly explain why the specification exists, what is the problem solved here.
+
+## Specification
+
+Explain things in depth.
+
+The resulting specification should be detailed enough to allow competing,
+interoperable implementations.
+
+### Test fixtures
+
+List relevant CIDs. Describe how implementations can use them to determine
+specification compliance.
+
+### Security
+
+Explain the security implications/considerations relevant to the spec.
+
+### Privacy and User Control
+
+Note if there are any privacy or user control considerations that should be
+taken into account by the implementers.
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).