Skip to content

Commit 10cb8b4

Browse files
committed
chore: simplify template
- table of contents is now generated - TODOs make things easier to spot during review
1 parent 52eee2d commit 10cb8b4

File tree

1 file changed

+6
-14
lines changed

1 file changed

+6
-14
lines changed

template.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,31 @@ editors:
99
github: yourGitHubHandle
1010
---
1111

12-
One paragraph explanation of the specification
13-
14-
## Organization of this document
15-
16-
- [Introduction](#introduction)
17-
- [Specification](#specification)
18-
- [Test fixtures](#test-fixtures)
19-
- [Security](#security)
20-
- [Privacy and User Control](#privacy-and-user-control)
12+
TODO: One paragraph explanation of the specification
2113

2214
## Introduction
2315

24-
Clearly explain why the specification exists, what is the problem solved here.
16+
TODO: Clearly explain why the specification exists, what is the problem solved here.
2517

2618
## Specification
2719

28-
Explain things in depth.
20+
TODO: Explain things in depth.
2921

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

3325
### Test fixtures
3426

35-
List relevant CIDs. Describe how implementations can use them to determine
27+
TODO: List relevant CIDs. Describe how implementations can use them to determine
3628
specification compliance.
3729

3830
### Security
3931

40-
Explain the security implications/considerations relevant to the spec.
32+
TODO: Explain the security implications/considerations relevant to the spec.
4133

4234
### Privacy and User Control
4335

44-
Note if there are any privacy or user control considerations that should be
36+
TODO: Note if there are any privacy or user control considerations that should be
4537
taken into account by the implementers.
4638

4739
## Copyright

0 commit comments

Comments
 (0)