From 462456f5829be63fca53193f3602cb152c30277e Mon Sep 17 00:00:00 2001 From: Trevin Chow Date: Sun, 15 Mar 2026 14:57:35 -0700 Subject: [PATCH 1/2] docs(plugin): move compound-engineering instructions into AGENTS --- plugins/compound-engineering/AGENTS.md | 110 +++++++++++++++++++++++++ plugins/compound-engineering/CLAUDE.md | 98 +--------------------- 2 files changed, 111 insertions(+), 97 deletions(-) create mode 100644 plugins/compound-engineering/AGENTS.md diff --git a/plugins/compound-engineering/AGENTS.md b/plugins/compound-engineering/AGENTS.md new file mode 100644 index 0000000..4c7d666 --- /dev/null +++ b/plugins/compound-engineering/AGENTS.md @@ -0,0 +1,110 @@ +# Plugin Instructions + +These instructions apply when working under `plugins/compound-engineering/`. +They supplement the repo-root `AGENTS.md`. + +# Compounding Engineering Plugin Development + +## Versioning Requirements + +**IMPORTANT**: Routine PRs should not cut releases for this plugin. + +The repo uses an automatied release process to prepare plugin releases, including version selection and changelog generation. Because multiple PRs may merge before the next release, contributors cannot know the final released version from within an individual PR. + +### Contributor Rules + +- Do **not** manually bump `.claude-plugin/plugin.json` version in a normal feature PR. +- Do **not** manually bump `.claude-plugin/marketplace.json` plugin version in a normal feature PR. +- Do **not** cut a release section in `CHANGELOG.md` for a normal feature PR. +- Do update substantive docs that are part of the actual change, such as `README.md`, component tables, usage instructions, or counts when they would otherwise become inaccurate. + +### Pre-Commit Checklist + +Before committing ANY changes: + +- [ ] No manual release-version bump in `.claude-plugin/plugin.json` +- [ ] No manual release-version bump in `.claude-plugin/marketplace.json` +- [ ] No manual release entry added to `CHANGELOG.md` +- [ ] README.md component counts verified +- [ ] README.md tables accurate (agents, commands, skills) +- [ ] plugin.json description matches current counts + +### Directory Structure + +``` +agents/ +├── review/ # Code review agents +├── research/ # Research and analysis agents +├── design/ # Design and UI agents +└── docs/ # Documentation agents + +skills/ +├── ce-*/ # Core workflow skills (ce:plan, ce:review, etc.) +├── workflows-*/ # Deprecated aliases for ce:* skills +└── */ # All other skills +``` + +> **Note:** Commands were migrated to skills in v2.39.0. All former +> `/command-name` slash commands now live under `skills/command-name/SKILL.md` +> and work identically in Claude Code. Other targets may convert or map these references differently. + +## Command Naming Convention + +**Workflow commands** use `ce:` prefix to unambiguously identify them as compound-engineering commands: +- `/ce:brainstorm` - Explore requirements and approaches before planning +- `/ce:plan` - Create implementation plans +- `/ce:review` - Run comprehensive code reviews +- `/ce:work` - Execute work items systematically +- `/ce:compound` - Document solved problems + +**Why `ce:`?** Claude Code has built-in `/plan` and `/review` commands. The `ce:` namespace (short for compound-engineering) makes it immediately clear these commands belong to this plugin. The legacy `workflows:` prefix is still supported as deprecated aliases that forward to the `ce:*` equivalents. + +## Skill Compliance Checklist + +When adding or modifying skills, verify compliance with the skill spec: + +### YAML Frontmatter (Required) + +- [ ] `name:` present and matches directory name (lowercase-with-hyphens) +- [ ] `description:` present and describes **what it does and when to use it** (per official spec: "Explains code with diagrams. Use when exploring how code works.") + +### Reference Links (Required if references/ exists) + +- [ ] All files in `references/` are linked as `[filename.md](./references/filename.md)` +- [ ] All files in `assets/` are linked as `[filename](./assets/filename)` +- [ ] All files in `scripts/` are linked as `[filename](./scripts/filename)` +- [ ] No bare backtick references like `` `references/file.md` `` - use proper markdown links + +### Writing Style + +- [ ] Use imperative/infinitive form (verb-first instructions) +- [ ] Avoid second person ("you should") - use objective language ("To accomplish X, do Y") + +### Cross-Platform User Interaction + +- [ ] When a skill needs to ask the user a question, instruct use of the platform's blocking question tool and name the known equivalents (`AskUserQuestion` in Claude Code, `request_user_input` in Codex, `ask_user` in Gemini) +- [ ] Include a fallback for environments without a question tool (e.g., present numbered options and wait for the user's reply before proceeding) + +### Cross-Platform Reference Rules + +This plugin is authored once, then converted for other agent platforms. Commands and agents are transformed during that conversion, but `plugin.skills` are usually copied almost exactly as written. + +- [ ] Because of that, slash references inside command or agent content are acceptable when they point to real published commands; target-specific conversion can remap them. +- [ ] Inside a pass-through `SKILL.md`, do not assume slash references will be remapped for another platform. Write references according to what will still make sense after the skill is copied as-is. +- [ ] When one skill refers to another skill, prefer semantic wording such as "load the `document-review` skill" rather than slash syntax. +- [ ] Use slash syntax only when referring to an actual published command or workflow such as `/ce:work` or `/deepen-plan`. + +### Quick Validation Command + +```bash +# Check for unlinked references in a skill +grep -E '`(references|assets|scripts)/[^`]+`' skills/*/SKILL.md +# Should return nothing if all refs are properly linked + +# Check description format - should describe what + when +grep -E '^description:' skills/*/SKILL.md +``` + +## Documentation + +See `docs/solutions/plugin-versioning-requirements.md` for detailed versioning workflow. diff --git a/plugins/compound-engineering/CLAUDE.md b/plugins/compound-engineering/CLAUDE.md index 7d9463a..43c994c 100644 --- a/plugins/compound-engineering/CLAUDE.md +++ b/plugins/compound-engineering/CLAUDE.md @@ -1,97 +1 @@ -# Compounding Engineering Plugin Development - -## Versioning Requirements - -**IMPORTANT**: Routine PRs should not cut releases for this plugin. - -The repo uses an automatied release process to prepare plugin releases, including version selection and changelog generation. Because multiple PRs may merge before the next release, contributors cannot know the final released version from within an individual PR. - -### Contributor Rules - -- Do **not** manually bump `.claude-plugin/plugin.json` version in a normal feature PR. -- Do **not** manually bump `.claude-plugin/marketplace.json` plugin version in a normal feature PR. -- Do **not** cut a release section in `CHANGELOG.md` for a normal feature PR. -- Do update substantive docs that are part of the actual change, such as `README.md`, component tables, usage instructions, or counts when they would otherwise become inaccurate. - -### Pre-Commit Checklist - -Before committing ANY changes: - -- [ ] No manual release-version bump in `.claude-plugin/plugin.json` -- [ ] No manual release-version bump in `.claude-plugin/marketplace.json` -- [ ] No manual release entry added to `CHANGELOG.md` -- [ ] README.md component counts verified -- [ ] README.md tables accurate (agents, commands, skills) -- [ ] plugin.json description matches current counts - -### Directory Structure - -``` -agents/ -├── review/ # Code review agents -├── research/ # Research and analysis agents -├── design/ # Design and UI agents -├── workflow/ # Workflow automation agents -└── docs/ # Documentation agents - -skills/ -├── ce-*/ # Core workflow skills (ce:plan, ce:review, etc.) -├── workflows-*/ # Deprecated aliases for ce:* skills -└── */ # All other skills -``` - -> **Note:** Commands were migrated to skills in v2.39.0. All former -> `/command-name` slash commands now live under `skills/command-name/SKILL.md` -> and work identically (Claude Code 2.1.3+ merged the two formats). - -## Command Naming Convention - -**Workflow commands** use `ce:` prefix to unambiguously identify them as compound-engineering commands: -- `/ce:plan` - Create implementation plans -- `/ce:review` - Run comprehensive code reviews -- `/ce:work` - Execute work items systematically -- `/ce:compound` - Document solved problems -- `/ce:brainstorm` - Explore requirements and approaches before planning - -**Why `ce:`?** Claude Code has built-in `/plan` and `/review` commands. The `ce:` namespace (short for compound-engineering) makes it immediately clear these commands belong to this plugin. The legacy `workflows:` prefix is still supported as deprecated aliases that forward to the `ce:*` equivalents. - -## Skill Compliance Checklist - -When adding or modifying skills, verify compliance with skill-creator spec: - -### YAML Frontmatter (Required) - -- [ ] `name:` present and matches directory name (lowercase-with-hyphens) -- [ ] `description:` present and describes **what it does and when to use it** (per official spec: "Explains code with diagrams. Use when exploring how code works.") - -### Reference Links (Required if references/ exists) - -- [ ] All files in `references/` are linked as `[filename.md](./references/filename.md)` -- [ ] All files in `assets/` are linked as `[filename](./assets/filename)` -- [ ] All files in `scripts/` are linked as `[filename](./scripts/filename)` -- [ ] No bare backtick references like `` `references/file.md` `` - use proper markdown links - -### Writing Style - -- [ ] Use imperative/infinitive form (verb-first instructions) -- [ ] Avoid second person ("you should") - use objective language ("To accomplish X, do Y") - -### Cross-Platform User Interaction - -- [ ] When a skill needs to ask the user a question, instruct use of the platform's blocking question tool and name the known equivalents (`AskUserQuestion` in Claude Code, `request_user_input` in Codex, `ask_user` in Gemini) -- [ ] Include a fallback for environments without a question tool (e.g., present numbered options and wait for the user's reply before proceeding) - -### Quick Validation Command - -```bash -# Check for unlinked references in a skill -grep -E '`(references|assets|scripts)/[^`]+`' skills/*/SKILL.md -# Should return nothing if all refs are properly linked - -# Check description format - should describe what + when -grep -E '^description:' skills/*/SKILL.md -``` - -## Documentation - -See `docs/solutions/plugin-versioning-requirements.md` for detailed versioning workflow. +@AGENTS.md From c77e01bb61b9bd094d4167552cdb9a1605fdf178 Mon Sep 17 00:00:00 2001 From: Trevin Chow Date: Sun, 15 Mar 2026 14:57:42 -0700 Subject: [PATCH 2/2] docs: normalize repo paths in converter guidance --- docs/solutions/adding-converter-target-providers.md | 8 ++++---- docs/solutions/plugin-versioning-requirements.md | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/solutions/adding-converter-target-providers.md b/docs/solutions/adding-converter-target-providers.md index cccda03..76331d9 100644 --- a/docs/solutions/adding-converter-target-providers.md +++ b/docs/solutions/adding-converter-target-providers.md @@ -687,7 +687,7 @@ Use this checklist when adding a new target provider: ## Related Files -- `/C:/Source/compound-engineering-plugin/.claude-plugin/plugin.json` — Version and component counts -- `/C:/Source/compound-engineering-plugin/CHANGELOG.md` — Recent additions and patterns -- `/C:/Source/compound-engineering-plugin/README.md` — Usage examples for all targets -- `/C:/Source/compound-engineering-plugin/docs/solutions/plugin-versioning-requirements.md` — Checklist for releases +- `plugins/compound-engineering/.claude-plugin/plugin.json` — Version and component counts +- `CHANGELOG.md` — Recent additions and patterns +- `README.md` — Usage examples for all targets +- `docs/solutions/plugin-versioning-requirements.md` — Checklist for releases diff --git a/docs/solutions/plugin-versioning-requirements.md b/docs/solutions/plugin-versioning-requirements.md index aa53984..a7ac152 100644 --- a/docs/solutions/plugin-versioning-requirements.md +++ b/docs/solutions/plugin-versioning-requirements.md @@ -72,8 +72,8 @@ This documentation serves as a reminder. When Claude Code works on this plugin, ## Related Files -- `/Users/kieranklaassen/compound-engineering-plugin/plugins/compound-engineering/.claude-plugin/plugin.json` -- `/Users/kieranklaassen/compound-engineering-plugin/plugins/compound-engineering/CHANGELOG.md` -- `/Users/kieranklaassen/compound-engineering-plugin/plugins/compound-engineering/README.md` -- `/Users/kieranklaassen/compound-engineering-plugin/package.json` -- `/Users/kieranklaassen/compound-engineering-plugin/CHANGELOG.md` +- `plugins/compound-engineering/.claude-plugin/plugin.json` +- `plugins/compound-engineering/CHANGELOG.md` +- `plugins/compound-engineering/README.md` +- `package.json` +- `CHANGELOG.md`