Skip to content

Commit 279398d

Browse files
committed
chore: Convert info tables to bullet lists in review skill docs
1 parent 11a93ae commit 279398d

4 files changed

Lines changed: 44 additions & 64 deletions

File tree

.claude/skills/parallel-review/SKILL.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@ If the argument is `$ARGUMENTS`, interpret it as the review target specification
2525

2626
## Options
2727

28-
| Option | Default | Description |
29-
|--------|---------|-------------|
30-
| `--base {branch}` | `main` or `master` | Specifies the base branch |
28+
- `--base {branch}` — Specifies the base branch. Defaults to `main` or `master`.
3129

3230
### Default Review Targets
3331

@@ -42,21 +40,17 @@ If a base branch is not specified via `--base`, use `main` or `master` if either
4240

4341
### Required (always launched)
4442

45-
| Reviewer | Perspective |
46-
|----------|-------------|
47-
| **cpp-sensei** | C++ language specification, coding conventions, memory management, RAII, type safety, undefined behavior, multithreading, thread safety, performance |
48-
| **qt-sensei** | Qt API usage, signal/slot correctness, object ownership and lifetime, QObject thread affinity, UI thread safety (QMetaObject::invokeMethod), resource management, Qt best practices |
49-
| **obs-sensei** | OBS Studio API correctness, plugin lifecycle, source/filter/output management, OBS threading model, RAII wrappers (OBSSourceAutoRelease, etc.), settings handling, frontend API usage, OBS plugin conventions |
50-
| **network-sensei** | Networking correctness, TCP/IP, HTTP, SSL/TLS, WebSocket, socket communication, streaming protocols (RTMP/SRT/WebRTC), connection lifecycle, error handling, reconnection logic, security |
43+
- `cpp-sensei` — C++ language specification, coding conventions, memory management, RAII, type safety, undefined behavior, multithreading, thread safety, performance.
44+
- `qt-sensei` — Qt API usage, signal/slot correctness, object ownership and lifetime, QObject thread affinity, UI thread safety (QMetaObject::invokeMethod), resource management, Qt best practices.
45+
- `obs-sensei` — OBS Studio API correctness, plugin lifecycle, source/filter/output management, OBS threading model, RAII wrappers (OBSSourceAutoRelease, etc.), settings handling, frontend API usage, OBS plugin conventions.
46+
- `network-sensei` — Networking correctness, TCP/IP, HTTP, SSL/TLS, WebSocket, socket communication, streaming protocols (RTMP/SRT/WebRTC), connection lifecycle, error handling, reconnection logic, security.
5147

5248
### Optional (launched based on user request or review scope)
5349

54-
| Reviewer | Perspective | Inclusion Criteria |
55-
|----------|-------------|--------------------|
56-
| **av-sensei** | Video/audio/streaming quality, encoder settings, media processing, codec behavior, distribution operations | Reviews involving encoder settings, media pipelines, A/V quality, or streaming output configuration |
57-
| **devops-sensei** | CI/CD (GitHub Actions), CMake, clang-format, build scripts, Inno Setup, development tooling | Reviews involving the build system, CI workflows, packaging, or tool changes |
58-
| **python-sensei** | Python scripting, OBS Studio script design and conventions | Reviews involving Python scripts or OBS Script files |
59-
| **lua-sensei** | Lua scripting, OBS Studio Script (Lua) design and conventions | Reviews involving Lua scripts or OBS Lua Script files |
50+
- `av-sensei` — Video/audio/streaming quality, encoder settings, media processing, codec behavior, distribution operations. Include for reviews involving encoder settings, media pipelines, A/V quality, or streaming output configuration.
51+
- `devops-sensei` — CI/CD (GitHub Actions), CMake, clang-format, build scripts, Inno Setup, development tooling. Include for reviews involving the build system, CI workflows, packaging, or tool changes.
52+
- `python-sensei` — Python scripting, OBS Studio script design and conventions. Include for reviews involving Python scripts or OBS Script files.
53+
- `lua-sensei` — Lua scripting, OBS Studio Script (Lua) design and conventions. Include for reviews involving Lua scripts or OBS Lua Script files.
6054

6155
## Step 1 — Identify Review Scope and Fetch Diff
6256

.claude/skills/review-resolve/SKILL.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,18 @@ Review documents are generated by parallel-review and contain metadata markers a
3636

3737
The current state of each finding is determined from **the fields present between the markers**:
3838

39-
| Content present between the markers | State |
40-
|---|---|
41-
| None | Not yet triaged |
42-
| `Triage: 🔧 Will Fix` only | Triaged, estimate not yet completed |
43-
| `Triage: 🚫 Won't Fix` | Confirmed as no action needed |
44-
| `Estimate: ▶️ Maintain`, no `Status:` | Estimated, fix not yet completed |
45-
| `Estimate: 🔻 Downgrade` | Fell out at estimate as no-action |
46-
| `Estimate: 🚧 Alternative`, no `Status:` | Fell out at estimate to alternative; FIXME insertion not yet completed |
47-
| `Status: 🟢 Fixed` | Fix complete (Maintain fix, or Alternative FIXME insertion) |
39+
- Markers are empty → not yet triaged.
40+
- `Triage: 🔧 Will Fix` only → triaged, estimate not yet completed.
41+
- `Triage: 🚫 Won't Fix` → confirmed as no action needed.
42+
- `Estimate: ▶️ Maintain` with no `Status:` → estimated, fix not yet completed.
43+
- `Estimate: 🔻 Downgrade` → fell out at estimate as no-action.
44+
- `Estimate: 🚧 Alternative` with no `Status:` → fell out at estimate to alternative; FIXME insertion not yet completed.
45+
- `Status: 🟢 Fixed` → fix complete (Maintain fix, or Alternative FIXME insertion).
4846

4947
review-resolve appends a `verification` field in the following format:
5048

51-
| Value | Meaning |
52-
|-------|---------|
53-
| `✅ Verified — {concise verification result}` | Resolved |
54-
| `💬 Feedback — {what is missing and what is needed for full resolution}` | Feedback required |
49+
- `✅ Verified — {concise verification result}` — Resolved.
50+
- `💬 Feedback — {what is missing and what is needed for full resolution}` — Feedback required.
5551

5652
Do not write a `verification` for Unresolved findings.
5753

.claude/skills/review-respond/SKILL.md

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,8 @@ The user specifies a path to a review document (markdown). If the argument is `$
1616

1717
## Options
1818

19-
| Option | Default | Description |
20-
|--------|---------|-------------|
21-
| `--commit` | OFF | Create a commit for each finding fix |
22-
| `--confirm` | OFF | Wait for user confirmation immediately after the estimate results are available |
19+
- `--commit` (default OFF) — Create a commit for each finding fix.
20+
- `--confirm` (default OFF) — Wait for user confirmation immediately after the estimate results are available.
2321

2422
### `--commit` Option
2523

@@ -64,12 +62,10 @@ Review documents are generated by parallel-review and contain metadata markers (
6462

6563
review-respond and review-resolve append the following fields between the markers:
6664

67-
| Field | Set by | Value format |
68-
|-------|--------|--------------|
69-
| `triage` | review-respond Step 2 | `🔧 Will Fix (assignee: {specialist}) — {triage rationale}` / `🚫 Won't Fix — {reason no action is needed}` |
70-
| `estimate` | review-respond Step 3 | `▶️ Maintain — Cost: {S/M/L}, Future: {S/M/L}, Signals: {none\|a,b,c,d,e,f}` / `🔻 Downgrade — Cost: ..., Future: ..., Signals: ... — {downgrade rationale}` / `🚧 Alternative — Cost: ..., Future: ..., Signals: ... — FIXME insertion: {direction}` |
71-
| `status` | review-respond Step 4 | `🟢 Fixed — {concise description of what was fixed}` |
72-
| `verification` | review-resolve | `✅ Verified — {concise description of the verification result}` |
65+
- `triage` (set by: review-respond Step 2) — Value format: `🔧 Will Fix (assignee: {specialist}) — {triage rationale}` / `🚫 Won't Fix — {reason no action is needed}`.
66+
- `estimate` (set by: review-respond Step 3) — Value format: `▶️ Maintain — Cost: {S/M/L}, Future: {S/M/L}, Signals: {none\|a,b,c,d,e,f}` / `🔻 Downgrade — Cost: ..., Future: ..., Signals: ... — {downgrade rationale}` / `🚧 Alternative — Cost: ..., Future: ..., Signals: ... — FIXME insertion: {direction}`.
67+
- `status` (set by: review-respond Step 4) — Value format: `🟢 Fixed — {concise description of what was fixed}`.
68+
- `verification` (set by: review-resolve) — Value format: `✅ Verified — {concise description of the verification result}`.
7369

7470
### Value Constraints
7571

@@ -79,15 +75,13 @@ review-respond and review-resolve append the following fields between the marker
7975

8076
### Emoji Reference
8177

82-
| Prefix | Stage | Verdict | Emoji | Meaning |
83-
|--------|-------|---------|-------|---------|
84-
| `triage` | Step 2 | `Will Fix` | 🔧 | Confirmed as a fix target |
85-
| `triage` || `Won't Fix` | 🚫 | Confirmed as no action needed |
86-
| `estimate` | Step 3 | `Maintain` | ▶️ | Maintain triage verdict (will fix) |
87-
| `estimate` || `Downgrade` | 🔻 | Overturn triage verdict; do not fix (no alternative) |
88-
| `estimate` || `Alternative` | 🚧 | Triage verdict overturned, but addressed via FIXME comment or similar alternative |
89-
| `status` | Step 4 | `Fixed` | 🟢 | Fix complete |
90-
| `verification` | review-resolve | `Verified` || Verification complete |
78+
- `triage` / Step 2 / `Will Fix` → 🔧 (confirmed as a fix target)
79+
- `triage` / Step 2 / `Won't Fix` → 🚫 (confirmed as no action needed)
80+
- `estimate` / Step 3 / `Maintain` → ▶️ (maintain triage verdict and proceed with the fix)
81+
- `estimate` / Step 3 / `Downgrade` → 🔻 (overturn triage verdict; do not fix; no alternative)
82+
- `estimate` / Step 3 / `Alternative` → 🚧 (triage verdict overturned, but addressed via FIXME comment or similar alternative)
83+
- `status` / Step 4 / `Fixed` → 🟢 (fix complete)
84+
- `verification` / review-resolve / `Verified` → ✅ (verification complete)
9185

9286
## Internal Processing (events.jsonl)
9387

@@ -249,16 +243,14 @@ Do not edit any source code, the review document, or events.jsonl.
249243

250244
Delegate `Estimate: ▶️ Maintain` (regular fix) and `Estimate: 🚧 Alternative` (FIXME insertion) to specialists chosen by the nature of the finding:
251245

252-
| Specialist | When to use |
253-
|------------|-------------|
254-
| **cpp-sensei** | C++ language issues, memory management, RAII, thread safety, undefined behavior, performance |
255-
| **qt-sensei** | Qt API usage, signals/slots, object lifetime, thread affinity, UI thread safety |
256-
| **obs-sensei** | OBS API correctness, plugin lifecycle, sources/filters/outputs, OBS threading model |
257-
| **network-sensei** | Networking, protocols, connection lifecycle, security |
258-
| **av-sensei** | Video/audio/streaming quality, encoder settings, media processing |
259-
| **devops-sensei** | CI/CD, CMake, build scripts, formatters, packaging |
260-
| **python-sensei** | Python scripts, OBS Python Script |
261-
| **lua-sensei** | Lua scripts, OBS Lua Script |
246+
- `cpp-sensei` — C++ language issues, memory management, RAII, thread safety, undefined behavior, performance.
247+
- `qt-sensei` — Qt API usage, signals/slots, object lifetime, thread affinity, UI thread safety.
248+
- `obs-sensei` — OBS API correctness, plugin lifecycle, sources/filters/outputs, OBS threading model.
249+
- `network-sensei` — Networking, protocols, connection lifecycle, security.
250+
- `av-sensei` — Video/audio/streaming quality, encoder settings, media processing.
251+
- `devops-sensei` — CI/CD, CMake, build scripts, formatters, packaging.
252+
- `python-sensei` — Python scripts, OBS Python Script.
253+
- `lua-sensei` — Lua scripts, OBS Lua Script.
262254

263255
### Agent Prompt Template
264256

.claude/skills/review-rounds/SKILL.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,11 @@ The user may optionally specify an output base path. If the argument is `$ARGUME
1616

1717
## Options
1818

19-
| Option | Default | Description |
20-
|--------|---------|-------------|
21-
| `--confirm` | OFF | Wait for user confirmation immediately after estimates are gathered (before proceeding to fixes) |
22-
| `--confirm-round` | OFF | After review-resolve, if unresolved findings remain, wait for user confirmation before proceeding to the next round |
23-
| `--commit` | OFF | Create a git commit after each finding fix (the orchestrator performs aggregated commits) |
24-
| `--max-rounds N` | 5 | Change the maximum number of outer-loop rounds (1–10) |
25-
| `--base {branch}` | `main` or `master` | Specify the base branch (passed through to parallel-review) |
19+
- `--confirm` (default OFF) — Wait for user confirmation immediately after estimates are gathered (before proceeding to fixes).
20+
- `--confirm-round` (default OFF) — After review-resolve, if unresolved findings remain, wait for user confirmation before proceeding to the next round.
21+
- `--commit` (default OFF) — Create a git commit after each finding fix (the orchestrator performs aggregated commits).
22+
- `--max-rounds N` (default 5, range 1–10) — Change the maximum number of outer-loop rounds.
23+
- `--base {branch}` (default `main` or `master`) — Specify the base branch (passed through to parallel-review).
2624

2725
## Review Document File Naming
2826

0 commit comments

Comments
 (0)