From 4521eb7a4b0d4a4ff8cf9153484d0596c5143170 Mon Sep 17 00:00:00 2001 From: Alexander Foremny Date: Thu, 19 Oct 2023 09:57:19 +0200 Subject: add glossary --- SPEC.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 SPEC.md diff --git a/SPEC.md b/SPEC.md new file mode 100644 index 0000000..f921c1c --- /dev/null +++ b/SPEC.md @@ -0,0 +1,21 @@ +# A plain-text in-code format for issue management + +## Glossary + +comment +: A comment block with a comment marker and Markdown content. + +comment block +: A multi-line comment or consecutive block of single-line comments as defined by the file's programming language as determined by its file extension. + +issue +: A comment block with an issue marker and Markdown content. + +marker +: A predefined keyword in all capitals that defines the semantics of the comment block in which it appears as the first word. + +provenance +: Given an issue (and implicitly a Git history) the *provenance* of that issue is the pair of commits that first created that issue and that last modified that issue (within that Git history). + +tag +: A word in pascal-case in a comment or an issue, outside code blocks or inline code, prefixed with `@`, and optionally associating with it the following word as its value. -- cgit v1.2.3