4b2820bdce
Update all documentation to show the correct command syntax: - `/plan`, `/review`, `/work`, `/codify` (short form, autocompletes) Previously showed `/workflows:plan` etc. which doesn't work. The `name:` field in frontmatter determines the short command name. Fixes #19 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
# Compounding Engineering Plugin Development
|
|
|
|
## Versioning Requirements
|
|
|
|
**IMPORTANT**: Every change to this plugin MUST include updates to all three files:
|
|
|
|
1. **`.claude-plugin/plugin.json`** - Bump version using semver
|
|
2. **`CHANGELOG.md`** - Document changes using Keep a Changelog format
|
|
3. **`README.md`** - Verify/update component counts and tables
|
|
|
|
### Version Bumping Rules
|
|
|
|
- **MAJOR** (1.0.0 → 2.0.0): Breaking changes, major reorganization
|
|
- **MINOR** (1.0.0 → 1.1.0): New agents, commands, or skills
|
|
- **PATCH** (1.0.0 → 1.0.1): Bug fixes, doc updates, minor improvements
|
|
|
|
### Pre-Commit Checklist
|
|
|
|
Before committing ANY changes:
|
|
|
|
- [ ] Version bumped in `.claude-plugin/plugin.json`
|
|
- [ ] CHANGELOG.md updated with changes
|
|
- [ ] 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
|
|
|
|
commands/
|
|
├── workflows/ # Core workflow commands (/plan, /review, /work, /codify)
|
|
└── *.md # Utility commands
|
|
|
|
skills/
|
|
└── *.md # All skills at root level
|
|
```
|
|
|
|
## Documentation
|
|
|
|
See `docs/solutions/plugin-versioning-requirements.md` for detailed versioning workflow.
|