aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Alexander Foremny <aforemny@posteo.de>2023-10-19 09:57:19 +0200
committerLibravatar Alexander Foremny <aforemny@posteo.de>2023-10-19 09:58:08 +0200
commit4521eb7a4b0d4a4ff8cf9153484d0596c5143170 (patch)
treeec0e9a1b98f04100a116216f204341df46166686
parent737aec8c1f31077b1a4e1ada1e33d25c1612fec8 (diff)
add glossary
-rw-r--r--SPEC.md21
1 files changed, 21 insertions, 0 deletions
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.