blob: f921c1c278ba499c5c2e1ed2b1ef0c28f8bc5f53 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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.
|
