Skip to content

CLAUDE.md

Latest commit

 

History

History
68 lines (48 loc) · 3.43 KB

CLAUDE.md

File metadata and controls

68 lines (48 loc) · 3.43 KB
Raw

CLAUDE.md

This file provides guidance to AI coding agents working with this repo.

Overview

AI marketplace for UXD teams and the products they support. This repo contains plugin definitions (skills and agents) that are published to Claude and Cursor marketplaces.

Working in this repo

  • Do NOT edit PLUGINS.md directly — it is auto-generated by bash scripts/generate-plugins-md.sh and will be overwritten
  • After adding or renaming skills/agents, run bash scripts/generate-plugins-md.sh to regenerate PLUGINS.md and the README plugin table
  • Plugin manifests (plugin.json) must be identical in .claude-plugin/ and .cursor-plugin/ — always update both. Marketplace configs (marketplace.json) may differ between platforms.
  • Do not add mcpServers to plugin.json files — the PatternFly MCP is a separate user install
  • All PF plugins use the pf- prefix (e.g., pf-react, pf-design-audit)
  • All UXD plugins use the uxd- prefix (e.g., uxd-workshop)
  • All skills and agents follow the same prefix convention (pf-test-gen, uxd-prototype-create)

Context Routing

Load additional context based on the task at hand:

  • If contributing a new skill or agent: READ CONTRIBUTING-SKILLS.md
  • If working on plugin manifests: READ CONTRIBUTING.md → "Creating a new plugin"

Project Structure

plugins/uxd-workshop/              — UXD plugins (top level)
plugins/patternfly/                — PatternFly meta-plugin (installs all PF sub-plugins)
  ├── .claude-plugin/plugin.json   — Meta-plugin manifest (dependencies only, no skills)
  ├── agents/pf-assist.md          — PatternFly routing agent
  ├── pf-react/                    — Sub-plugin: React development
  ├── pf-design-guide/             — Sub-plugin: Design guidance
  └── ...
.claude-plugin/marketplace.json    — Claude marketplace config
.cursor-plugin/marketplace.json    — Cursor marketplace config
scripts/                           — Automation scripts

Meta-plugin Architecture

The patternfly plugin at plugins/patternfly/ is a meta-plugin — it uses a dependencies array to auto-install all PF sub-plugins (pf-react, pf-design-guide, pf-design-audit, pf-migration, pf-mcp). It has no skills of its own, only the pf-assist routing agent. Claude Code only — Cursor does not support dependencies, so Cursor users install sub-plugins individually.

Delisted plugins (kept on disk, not in marketplace.json):

  • pf-a11y — empty, no skills yet

Versioning

No version field in plugin.json — Claude Code falls back to git commit SHA, so every merge to main automatically invalidates the cache. No manual bumping needed.

Code Style

  • Skills must be tool-agnostic — they run in both Claude Code and Cursor
  • Avoid referencing a specific AI tool in skill instructions (use "Assistant:" not "Claude:")
  • Prefer bash for bundled scripts — no runtime dependency assumptions
  • Frontmatter is required in all SKILL.md and agent files with matching name and description

Auto-generated Files

The following files are generated by scripts and must never be edited manually:

File Generated by
PLUGINS.md bash scripts/generate-plugins-md.sh
README plugin table bash scripts/generate-plugins-md.sh
CONTRIBUTING-SKILLS.md plugin table bash scripts/generate-plugins-md.sh
Per-plugin README.md bash scripts/generate-plugins-md.sh