Skip to content

Commit

Permalink
ipip: add spec template.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Jul 8, 2022
1 parent b29f325 commit b0d6b2c
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 2 deletions.
5 changes: 3 additions & 2 deletions IPIP/0001-lightweight-improvement-proposal-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
52 changes: 52 additions & 0 deletions template.md
Original file line number Diff line number Diff line change
@@ -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/).

0 comments on commit b0d6b2c

Please sign in to comment.