mirror of
https://github.com/github/awesome-copilot.git
synced 2026-08-07 01:28:46 +00:00
chore: publish from main
This commit is contained in:
+18
-15
@@ -140,17 +140,15 @@ Skills are self-contained folders in the `skills/` directory that include a `SKI
|
||||
|
||||
### Adding Canvas Extensions
|
||||
|
||||
Canvas extensions live in `extensions/<extension-id>/` and are installable through plugin metadata.
|
||||
Canvas extensions live in `extensions/<extension-id>/` as reusable source components. They are shipped only through plugin manifests in `plugins/`.
|
||||
|
||||
1. **Create/update extension metadata**: Add `.github/plugin/plugin.json` in the extension folder
|
||||
2. **Use convention-based metadata**: Follow the extension plugin.json structure:
|
||||
1. **Create/update the extension source**: Add or update `extensions/<extension-id>/extension.mjs`
|
||||
2. **Register the extension plugin**: Add `plugins/<extension-id>/plugin.json`:
|
||||
- Required: `name` (matching folder name), `description`, `version`
|
||||
- Optional: `author`, `keywords`
|
||||
- `logo` **must** be exactly `"assets/preview.png"` (enforced convention)
|
||||
- `extensions` **must** be exactly `"."` (per [copilot-agent-runtime#9929](https://github.com/github/copilot-agent-runtime/pull/9929))
|
||||
- **Never** include `x-awesome-copilot` field (use convention-based assets only)
|
||||
- `extensions.com.github.copilot.logo` **must** be exactly `"assets/preview.png"`
|
||||
3. **Screenshot requirements**: Create `assets/preview.png` as your primary visual
|
||||
4. **Do not add `canvas.json`**: Extension website metadata is now sourced from `.github/plugin/plugin.json`
|
||||
4. **Do not add `canvas.json`**: Extension website metadata is sourced from the matching plugin manifest
|
||||
5. **Validate before submitting**: Run `npm run plugin:validate` to check compliance with conventions
|
||||
|
||||
### Adding Plugins
|
||||
@@ -159,7 +157,7 @@ Plugins group related agents, commands, and skills around specific themes or wor
|
||||
|
||||
1. **Create your plugin**: Run `npm run plugin:create` to scaffold a new plugin
|
||||
2. **Follow the naming convention**: Use descriptive, lowercase folder names with hyphens (e.g., `python-web-development`)
|
||||
3. **Define your content**: List agents, commands, and skills in `plugin.json` using the Claude Code spec fields
|
||||
3. **Define your content**: List agents, commands, hooks, skills, and reusable extensions under `extensions.com.github.awesome-copilot` in `plugin.json`
|
||||
4. **Test your plugin**: Run `npm run plugin:validate` to verify your plugin structure
|
||||
|
||||
#### Creating a plugin
|
||||
@@ -172,16 +170,17 @@ npm run plugin:create -- --name my-plugin-id
|
||||
|
||||
```
|
||||
plugins/my-plugin-id/
|
||||
├── .github/plugin/plugin.json # Plugin metadata (Claude Code spec format)
|
||||
├── plugin.json # Plugin metadata
|
||||
└── README.md # Plugin documentation
|
||||
```
|
||||
|
||||
> **Note:** Plugin content is defined declaratively in plugin.json using Claude Code spec fields (`agents`, `commands`, `skills`). Source files live in top-level directories and are materialized into plugins by CI.
|
||||
> **Note:** Plugin content is defined declaratively in plugin.json under `extensions.com.github.awesome-copilot`. Source files live in top-level directories and are materialized into plugins by CI. This repository namespace is removed from the served manifest.
|
||||
|
||||
#### plugin.json example
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://agent-plugins.org/schemas/1.0.0/plugin.schema.json",
|
||||
"name": "my-plugin-id",
|
||||
"description": "Plugin description",
|
||||
"version": "1.0.0",
|
||||
@@ -189,17 +188,21 @@ plugins/my-plugin-id/
|
||||
"author": { "name": "Awesome Copilot Community" },
|
||||
"repository": "https://github.com/github/awesome-copilot",
|
||||
"license": "MIT",
|
||||
"agents": ["./agents/my-agent.md"],
|
||||
"commands": ["./commands/my-command.md"],
|
||||
"skills": ["./skills/my-skill/"]
|
||||
"extensions": {
|
||||
"com.github.awesome-copilot": {
|
||||
"agents": ["./agents/my-agent.md"],
|
||||
"commands": ["./commands/my-command.md"],
|
||||
"skills": ["./skills/my-skill/"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Plugin Guidelines
|
||||
|
||||
- **Declarative content**: Plugin content is specified via `agents`, `commands`, and `skills` arrays in plugin.json — source files live in top-level directories and are materialized into plugins by CI
|
||||
- **Declarative content**: Plugin content is specified under `extensions.com.github.awesome-copilot` — source files live in top-level directories and are materialized into plugins by CI
|
||||
- **Valid references**: All paths referenced in plugin.json must point to existing source files in the repository
|
||||
- **Optional extension links**: Curated plugins can reference extensions using `x-awesome-copilot.extensions` with paths like `./extensions/<extension-id>`
|
||||
- **Reusable extensions**: Curated plugins can bundle extensions by adding `./extensions/<name>` paths under `extensions.com.github.awesome-copilot.extensions`; the same extension can be listed by multiple plugins
|
||||
- **Instructions excluded**: Instructions are standalone resources and are not part of plugins
|
||||
- **Clear purpose**: The plugin should solve a specific problem or workflow
|
||||
- **Validate before submitting**: Run `npm run plugin:validate` to ensure your plugin is valid
|
||||
|
||||
Reference in New Issue
Block a user