-
Notifications
You must be signed in to change notification settings - Fork 233
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
55 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/). |