-
Notifications
You must be signed in to change notification settings - Fork 0
feat(agents): add scaffold-plugin skill #45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| --- | ||
| name: scaffold-plugin | ||
| description: >- | ||
| Scaffold a new plugin in this repository with all required wiring. | ||
| Use when creating a new plugin from scratch. Do not use for adding skills to | ||
| an existing plugin or for modifying plugin metadata. | ||
| allowed-tools: | ||
| - Read | ||
| - Write | ||
| - Edit | ||
| - Bash | ||
| - Glob | ||
| - Grep | ||
| - AskUserQuestion | ||
| --- | ||
|
|
||
| # Scaffold a New Plugin | ||
|
|
||
| Create a new plugin with all the required files and registry wiring so it is ready for skills to be added. | ||
|
|
||
| ## When to Use | ||
|
|
||
| - Creating a brand new plugin in this repository | ||
| - User asks to "scaffold", "create", or "set up" a new plugin | ||
|
|
||
| ## When NOT to Use | ||
|
|
||
| - Adding skills to an existing plugin (just create the skill directory and SKILL.md) | ||
| - Modifying an existing plugin's metadata (edit plugin.json directly) | ||
| - Renaming or moving a plugin | ||
|
|
||
| ## Workflow | ||
|
|
||
| ### 1. Gather Plugin Information | ||
|
|
||
| Ask the user for the plugin name if not already provided. The name must: | ||
| - Use kebab-case | ||
| - Be prefixed with `trogonstack-` | ||
| - Be concise and descriptive | ||
|
|
||
| Ask for a one-line description if not already provided. | ||
|
|
||
| ### 2. Create Plugin Directory Structure | ||
|
|
||
| ``` | ||
| plugins/{plugin-name}/ | ||
| ├── .claude-plugin/ | ||
| │ └── plugin.json | ||
| ├── skills/ (empty, ready for skills) | ||
| └── README.md | ||
| ``` | ||
|
|
||
| Do NOT create a CHANGELOG.md — release-please manages that automatically. | ||
|
|
||
| ### 3. Create plugin.json | ||
|
|
||
| ```json | ||
| { | ||
| "name": "{plugin-name}", | ||
| "description": "{description}", | ||
| "version": "0.0.1", | ||
| "author": { | ||
| "name": "TrogonStack", | ||
| "url": "https://github.com/TrogonStack" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### 4. Create README.md | ||
|
|
||
| ````markdown | ||
| # {plugin-name} | ||
|
|
||
| {description} | ||
|
|
||
| ```bash | ||
| claude plugin install {plugin-name}@trogonstack | ||
| ``` | ||
| ```` | ||
|
|
||
| ### 5. Register in Marketplace | ||
|
|
||
| Add an entry to `.claude-plugin/marketplace.json` in the `plugins` array: | ||
|
|
||
| ```json | ||
| { | ||
| "name": "{plugin-name}", | ||
| "description": "{description}", | ||
| "source": "./plugins/{plugin-name}", | ||
| "category": "development" | ||
| } | ||
| ``` | ||
|
|
||
| ### 6. Register in Release Please Config | ||
|
|
||
| Add the package to `.github/release-please-config.json` in the `packages` object: | ||
|
|
||
| ```json | ||
| "plugins/{plugin-name}": { | ||
| "component": "{plugin-name}" | ||
| } | ||
| ``` | ||
|
|
||
| ### 7. Register in Release Please Manifest | ||
|
|
||
| Add the initial version to `.github/release-please-manifest.json`: | ||
|
|
||
| ```json | ||
| "plugins/{plugin-name}": "0.0.1" | ||
| ``` | ||
|
|
||
| It must be `0.0.1`. | ||
|
|
||
| ### 8. Commit | ||
|
|
||
| Use conventional commit format: | ||
|
|
||
| ``` | ||
| feat({plugin-name}): scaffold plugin for {short purpose} | ||
| ``` | ||
|
|
||
| ## Quality Checklist | ||
|
|
||
| - [ ] Plugin directory exists at `plugins/{plugin-name}/` | ||
| - [ ] `plugins/{plugin-name}/.claude-plugin/plugin.json` exists with correct name, description, version `0.0.1`, and author | ||
| - [ ] `plugins/{plugin-name}/README.md` exists with install command | ||
| - [ ] `plugins/{plugin-name}/skills/` directory exists (empty) | ||
| - [ ] No CHANGELOG.md was created | ||
| - [ ] `.claude-plugin/marketplace.json` has the new plugin entry | ||
| - [ ] `.github/release-please-config.json` has the new package | ||
| - [ ] `.github/release-please-manifest.json` has the new version entry at `0.0.1` | ||
| - [ ] Description is consistent across plugin.json, marketplace.json, and README.md | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.