메뉴
Core conventions and file layout for the companion-module-review project. Read this before writing any review output files.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | project-conventions |
| description | Core conventions and file layout for the companion-module-review project. Read this before writing any review output files. |
This is the companion-module-review repository — a Claude Code review system for BitFocus Companion modules. It reviews modules submitted to the BitFocus developer portal and writes structured review reports. It is report-only (see Process Directives).
companion-modules-reviewing/ inside this repo (gitignored).companion-module-templates/ inside this repo (gitignored).All assembled review files MUST be written to the reviews/ directory inside this repo — NOT to the module's own folder.
reviews/{short-module-name}/review-{short-module-name}-{version}-{YYYYMMDD}-{HHmmss}.md
{short-module-name} = the module folder name with the companion-module- prefix stripped.
| Module folder | Version | Correct output path |
|---|---|---|
companion-module-panasonic-ak-hrp1000 | v1.0.1 | reviews/panasonic-ak-hrp1000/review-panasonic-ak-hrp1000-v1.0.1-20260405-070000.md |
companion-module-red-rcp2 | v1.4.6 | reviews/red-rcp2/review-red-rcp2-v1.4.6-20260405-065528.md |
Timestamp: date -u +"%Y%m%d-%H%M%S". Create the dir first: mkdir -p reviews/{short-module-name}/.
❌ Never write a review file inside the module clone (companion-modules-reviewing/companion-module-*/).
review-{short-module-name}-{version}-{YYYYMMDD}-{HHmmss}.mdv prefix (e.g. v1.0.1).YYYYMMDD-HHmmss.After writing the review file, add a row to reviews/TRACKER.md (bottom of the table):
| ⬜ | {short-module-name} | {version} | {YYYY-MM-DD} | [review]({short-module-name}/review-{short-module-name}-{version}-{timestamp}.md) |
⬜ = feedback not yet submitted to the maintainer (default; the user changes it to ✅ after delivering).{YYYY-MM-DD} = review date (UTC); the link path is relative to reviews/.Verify a Companion module matches the official JS/TS template — required files, config-file parity, package.json/manifest.json fields, LICENSE, HELP.md, husky. Run scripts/validate-template.ps1 for the deterministic checks, then use this skill to interpret findings and judge the non-deterministic items. Use at the start of every module review.
Compliance checks for Companion modules on @companion-module/base v2.x (Companion 4.3+) — class-based export, removed runEntrypoint/parseVariablesInString, setVariableDefinitions object form, checkAllFeedbacks, manifest type connection. Use only when package.json resolves @companion-module/base to ^2.x. For 1.x modules use companion-v1-api-compliance instead.
Review a Bitfocus Companion module for release approval and produce a ranked review report. Use when the user says "review the next module", "review a/the (next) companion module", "review companion-module-X", "start a module review", or names a module. Supports a review scope — "just the tag/the changes" (tag), "the whole module / a full review" (module), or "both" — defaulting to tag. Runs the deterministic scripts, dispatches parallel review subagents, and assembles one review markdown — REPORT ONLY (never modifies the module).
Compliance checks for Companion modules on @companion-module/base v1.x (v1.5–v1.14, Companion 3.1–4.2). Use only when package.json resolves @companion-module/base to ^1.x or ~1.x. For 2.x modules use companion-v2-api-compliance instead.
Defines the standard scorecard and table of contents format for Companion module reviews. Use when assembling the final review file to generate the 📊 Scorecard section (issue counts by severity with New vs. Existing columns) and 📋 Table of Contents section (clickable anchor links to each finding).
Teaches the multi-file action pattern used in split-file Companion modules. Use when asked to add a new action category, create an action file, register actions in an aggregator, or extend the actions layer of a Companion module that splits actions across multiple files with a GetActions aggregator.