Skip to content

fix(writing-skills): add required plugin structure files to checklist #1

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.

Sign up for GitHub

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

Open
hanneskiivet wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(writing-skills): add required plugin structure files to checklist #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions skills/writing-skills/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,40 @@ API docs, syntax guides, tool documentation (office docs)

## Directory Structure

A plugin requires these files at its root:

```
.claude-plugin/
plugin.json # Plugin descriptor (required)
marketplace.json # Marketplace descriptor (required)
skills/
skill-name/
SKILL.md # Main reference (required)
supporting-file.* # Only if needed
```

**`plugin.json` minimal template:**
```json
{
"name": "your-plugin-name",
"description": "What this plugin does",
"version": "1.0.0",
"author": { "name": "Your Name", "email": "you@example.com" }
}
```

**`marketplace.json` minimal template:**
```json
{
"name": "your-plugin-name",
"description": "Marketplace description",
"owner": { "name": "Your Name" },
"plugins": [
{ "name": "your-plugin-name", "description": "...", "version": "1.0.0", "source": "./" }
]
}
```

**Flat namespace** - all skills in one searchable namespace

**Separate files for:**
Expand Down Expand Up @@ -629,6 +655,8 @@ Deploying untested skills = deploying untested code. It's a violation of quality
- [ ] Supporting files only for tools or heavy reference

**Deployment:**
- [ ] Verify `.claude-plugin/plugin.json` exists — create from template in Directory Structure if missing
- [ ] Verify `.claude-plugin/marketplace.json` exists — create from template in Directory Structure if missing
- [ ] Commit skill to git and push to your fork (if configured)
- [ ] Consider contributing back via PR (if broadly useful)

Expand Down