| name | plugin-devex-review |
| version | 0.1.0 |
| description | Developer-experience review for plugin onboarding. Use when evaluating a
plugin's fresh-clone setup, README flow, local testing instructions,
prerequisites, bundled CLIs, confusing paths, or contributor experience.
Inspired by GStack devex-review and QA workflows.
|
| triggers | ["plugin devex review","review plugin onboarding","fresh clone plugin test","make plugin easier to use","check plugin quickstart"] |
| allowed-tools | ["Read","Bash","Grep","Glob"] |
| mutating | true |
| writes_pages | false |
| writes_to | ["plugins/","README.md"] |
| disable-model-invocation | false |
Plugin Devex Review
Contract
A devex review produces:
- An automated onboarding-mechanics result from
scripts/devex_check.py
(README/skill coverage, --plugin-dir docs, script resolution/compile,
frontmatter name match).
- Fresh-user setup path with concrete commands.
- Measured or estimated time to first useful success.
- Missing prerequisites and confusing path names.
- One-command validation recommendation when useful.
- README or issue updates for discovered blockers.
Workflow
-
Scope
- Identify the target plugin.
- Read plugin
README.md, manifest, and visible skills.
- Run
git status --short --branch before editing.
-
Fresh-user path
-
Run the bundled onboarding checker first — it mechanizes the checks below
(README names every real skill and no phantom skills, --plugin-dir is
documented, referenced .py scripts resolve and compile, frontmatter
name matches its directory):
python3 "${CLAUDE_PLUGIN_ROOT}/skills/plugin-devex-review/scripts/devex_check.py" --plugin <plugin-name>
Exit 0 = onboarding mechanics pass; exit 1 = fix each FAIL: line
before continuing. NOTE: lines (e.g. non-executable scripts) are hints,
not blockers.
-
Verify install command appears in root and plugin docs.
-
Verify local testing command:
claude --plugin-dir ./plugins/<plugin-name>.
-
Verify expected first skill invocation is named.
-
For bundled CLIs, run <tool> --help or the wrapper help command when
safe and available.
-
Validation path
- Run
claude plugin validate plugins/<plugin-name> when available.
- Run
/plugin-manager:plugin-health or its script:
python3 "${CLAUDE_PLUGIN_ROOT}/skills/plugin-health/scripts/plugin_audit.py" --plugin <plugin-name> --json.
- Run focused tests for changed scripts.
-
Experience review
- Find jargon, missing prerequisites, stale paths, and commands that assume
private checkouts.
- Check whether README tells the user what success looks like.
- Prefer one clear quickstart over many equivalent alternatives.
-
Fix or file
- Fix straightforward docs and path confusion.
- For larger blockers, create or update GitHub issues with precise repro
steps and expected behavior.
Output Format
PLUGIN DEVEX REVIEW
Plugin: <name>
Fresh-user path: pass|fail
Time to first success: <duration or not measured>
Validation:
- <command>: pass|fail|not-run
Findings:
- <issue and fix/status>
Docs changed:
- <path>
Follow-up issues:
- <url or none>
Anti-Patterns
- Reviewing docs without running the commands they advertise.
- Requiring private local paths in public plugin instructions.
- Adding long setup prose instead of a shorter working quickstart.
- Filing vague issues without repro commands.