You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Replace the `(-)` token with `(off)` for "not applicable" findings:
`(-)` renders as a red forbidden icon in Jira and reads as a failure,
while the lines it prefixes list intentionally skipped checks. `(off)`
renders as a subtle grey switched-off lamp. Aligns comment-template.md
examples with the severity.md warning (they contradicted each other).
- Sanity scan: add check for unescaped block-markup tags ({code},
{noformat}, {quote}, {panel}) in prose - block tags are never inline;
literal mentions must be escaped as \{code\}.
- Sanity scan: add check that referenced attachments are linked with
[^filename] instead of bare filenames.
- qa-gather.sh: also match jira-qa-gather.py - jira-integration >= 3.13
ships the script under that name, so discovery silently fell back to
multi-call mode on current installs.
Signed-off-by: Sebastian Mendel <github@sebastianmendel.de>
(/) G3: default-path of {flag/config} still behaves as before
104
104
105
105
h4. Documentation
@@ -111,7 +111,7 @@ h4. Rollback / backout
111
111
(/) Backout path documented: {how}
112
112
113
113
h4. Communication
114
-
(-) n/a — internal-only change | (/) Announced in {channel} | (!) Customer-affecting; no announcement found
114
+
(off) n/a — internal-only change | (/) Announced in {channel} | (!) Customer-affecting; no announcement found
115
115
116
116
h4. Process compliance
117
117
(/) Comments in {code} blocks throughout
@@ -128,7 +128,7 @@ Ready to {transition-name-from-your-system}.
128
128
129
129
The **verdict line** must match your ticket system's actual transition name *and* the routing rule. For example, in a system where "QA passed" transitions to a customer-acceptance status, do not write "Ready to transition to QA passed" if the verdict is "internal-resolve" — that's a contradiction. Use the literal transition name that matches the routing decision (e.g. "Resolve" for internal-resolve, "QA passed" only when the next stop really is customer acceptance).
130
130
131
-
Keep it tight. Skip pillars that don't apply (e.g. omit "Communication" if `(-)` n/a). Don't pad with `(/)` for every check — list `(/)` items only when they're load-bearing or non-obvious.
131
+
Keep it tight. Skip pillars that don't apply (e.g. omit "Communication" if `(off)` n/a). Don't pad with `(/)` for every check — list `(/)` items only when they're load-bearing or non-obvious.
132
132
133
133
## Sanity scan before posting
134
134
@@ -140,6 +140,8 @@ Re-read your own comment before clicking *Add*. Common self-introduced bugs:
140
140
4.**Transition-name vs verdict mismatch** — the verdict's *meaning* and the *literal transition name* must agree (see above).
141
141
5.**Pillar P claims vs actual content** — if your P-pillar says "comments use `{code}` blocks" while your comment uses `{{monospace}}` for commands, that's the very contradiction the runbook is meant to prevent.
142
142
6.**Link audit on your own references** — every issue key, MR/PR, commit, or external URL you introduce must also exist as a structural link (issue link or web link), not just inline. See F4a (reviewer-side). *Anti-pattern:* "filed as NEW-TICKET" without the link.
143
+
7.**Unescaped block-markup tags in prose** — writing *about*`{code}` (or `{noformat}`, `{quote}`, `{panel}`) opens a real block right there in the rendered comment and swallows the rest of the line. These tags are block markup; any inline occurrence in prose is a smell. Escape as `\{code\}` when you mean the literal tag.
144
+
8.**Attachment mentioned but not linked** — when your comment references an attached file (session log, screenshot, report), link it with `[^filename.log]` so the reader gets a one-click open. A bare filename forces a scroll-and-hunt through the attachment list.
|`(?)`|`(?)`| open question for implementer | block on answer |
14
-
|`(-)`|*literal text*`n/a`| not applicable here | none — explicit "we considered this and it doesn't apply" |
14
+
|`(off)`|`(off)`| not applicable here | none — explicit "we considered this and it doesn't apply" |
15
15
16
16
In rendered Jira these become coloured icons. In other systems (GitHub, GitLab, Markdown), use the literal strings — they read clearly even unrendered.
17
17
18
-
**Watch out for `(-)`specifically**: in Jira wiki the `(-)` token renders as a *forbidden* / *no-entry* icon (🚫), not as "n/a". The forbidden icon visually says "blocked / denied", which is wrong for "not applicable here". Use **literal text** like `*n/a*` or write *"n/a — reason"* instead of the `(-)` token in Jira comments. The other tokens (`(/) (x) (!) (i) (?)`) render with semantically-correct icons.
18
+
**Never use `(-)`for "n/a"**: in Jira wiki the `(-)` token renders as a *red* forbidden / no-entry icon, which visually screams "error / blocked / denied" — readers scan it as a failure even though the line lists something that was *considered and intentionally skipped*. Use `(off)` instead: it renders as a subtle grey switched-off lamp, which reads as "nothing active here" without alarm colour. The other tokens (`(/) (x) (!) (i) (?)`) render with semantically-correct icons.
19
19
20
20
Also avoid using `(/)`, `(x)`, `(!)`, `(i)`, `(?)` literally in *prose* when you mean to *refer to* a finding by its severity. Jira will render the icon mid-sentence, which is visually confusing. Write "the SHOULD-fix finding" or "the warning above" instead of "the `(!)`".
21
21
@@ -57,9 +57,9 @@ If you can't decide between `(!)` and `(i)`: ask whether the issue would still b
57
57
58
58
> *(?) Was the OPNsense config snapshot taken before the major upgrade? I see the patch-update comment but not a snapshot mention.*
59
59
60
-
### `(-)` — n/a
60
+
### `(off)` — n/a
61
61
62
-
> *(-) Communication (C1–C3): change is internal-only (CI image refresh), no announcement needed.*
62
+
> *(off) Communication (C1–C3): change is internal-only (CI image refresh), no announcement needed.*
0 commit comments