From 10cb8b44a185ddade3e212b0a7cfd8cef68aedc0 Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Sun, 12 Nov 2023 12:49:37 +0100 Subject: [PATCH] chore: simplify template - table of contents is now generated - TODOs make things easier to spot during review --- template.md | 20 ++++++-------------- 1 file changed, 6 insertions(+), 14 deletions(-) diff --git a/template.md b/template.md index df40b202c..0a5945ef7 100644 --- a/template.md +++ b/template.md @@ -9,39 +9,31 @@ editors: github: yourGitHubHandle --- -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) +TODO: One paragraph explanation of the specification ## Introduction -Clearly explain why the specification exists, what is the problem solved here. +TODO: Clearly explain why the specification exists, what is the problem solved here. ## Specification -Explain things in depth. +TODO: 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 +TODO: List relevant CIDs. Describe how implementations can use them to determine specification compliance. ### Security -Explain the security implications/considerations relevant to the spec. +TODO: 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 +TODO: Note if there are any privacy or user control considerations that should be taken into account by the implementers. ## Copyright