|
| 1 | +# Contributing to ECA Plugins |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the ECA plugin marketplace! This guide walks you through the process of submitting a new plugin. |
| 4 | + |
| 5 | +## Plugin structure |
| 6 | + |
| 7 | +Each plugin lives under `plugins/<plugin-name>/` and can provide any combination of: |
| 8 | + |
| 9 | +``` |
| 10 | +plugins/my-plugin/ |
| 11 | +├── skills/ # Skill directories (each subfolder is a skill) |
| 12 | +│ └── my-skill/ |
| 13 | +│ └── my-skill.md |
| 14 | +├── agents/ # Agent definitions (Markdown files) |
| 15 | +│ └── my-agent.md |
| 16 | +├── commands/ # Custom commands (Markdown files) |
| 17 | +│ └── my-command.md |
| 18 | +├── rules/ # Rule files applied to conversations |
| 19 | +│ └── my-rule.md |
| 20 | +├── hooks/ # Hook definitions |
| 21 | +│ └── hooks.json |
| 22 | +├── .mcp.json # MCP server definitions |
| 23 | +├── eca.json # Arbitrary config overrides |
| 24 | +└── README.md # Documentation (displayed on the marketplace website) |
| 25 | +``` |
| 26 | + |
| 27 | +You don't need all of these — include only the components your plugin provides. |
| 28 | + |
| 29 | +## Adding a plugin |
| 30 | + |
| 31 | +### 1. Create the plugin directory |
| 32 | + |
| 33 | +```bash |
| 34 | +mkdir -p plugins/my-plugin |
| 35 | +``` |
| 36 | + |
| 37 | +### 2. Add your plugin components |
| 38 | + |
| 39 | +Add the files for your plugin (skills, agents, rules, etc.) following the structure above. |
| 40 | + |
| 41 | +### 3. Add a README |
| 42 | + |
| 43 | +Create `plugins/my-plugin/README.md` describing what your plugin does, how to use it, and any configuration options. |
| 44 | + |
| 45 | +### 4. Register in the marketplace |
| 46 | + |
| 47 | +Add an entry to `.eca-plugin/marketplace.json`: |
| 48 | + |
| 49 | +```json |
| 50 | +{ |
| 51 | + "name": "my-plugin", |
| 52 | + "description": "A short description of what your plugin does", |
| 53 | + "source": "plugins/my-plugin", |
| 54 | + "category": "Development", |
| 55 | + "tags": ["relevant", "tags"], |
| 56 | + "author": "Your Name", |
| 57 | + "icon": "🔧" |
| 58 | +} |
| 59 | +``` |
| 60 | + |
| 61 | +**Fields:** |
| 62 | + |
| 63 | +| Field | Required | Description | |
| 64 | +|-------|----------|-------------| |
| 65 | +| `name` | Yes | Unique plugin identifier (kebab-case) | |
| 66 | +| `description` | Yes | Short description (one sentence) | |
| 67 | +| `source` | Yes | Path to the plugin directory (relative to repo root) | |
| 68 | +| `category` | Yes | One of: `Development`, `Productivity`, `Documentation`, `DevOps`, `Data`, `Design` | |
| 69 | +| `tags` | Yes | Array of relevant tags for search/filtering | |
| 70 | +| `author` | Yes | Author name or organization | |
| 71 | +| `icon` | No | Emoji icon for the plugin card | |
| 72 | +| `featured` | No | Set to `true` for featured plugins (maintainers only) | |
| 73 | + |
| 74 | +### 5. Open a pull request |
| 75 | + |
| 76 | +Submit a PR with your plugin. We'll review it for: |
| 77 | + |
| 78 | +- **Usefulness** — Does it provide value to ECA users? |
| 79 | +- **Quality** — Are the skills/agents/rules well-written? |
| 80 | +- **Safety** — Does it follow responsible AI practices? |
| 81 | +- **Documentation** — Is the README clear and helpful? |
| 82 | + |
| 83 | +## Guidelines |
| 84 | + |
| 85 | +- Keep plugin names short and descriptive (kebab-case) |
| 86 | +- Write clear, concise skill/agent prompts |
| 87 | +- Include examples in your README |
| 88 | +- Test your plugin locally before submitting (add it as a local source in your ECA config) |
| 89 | +- One plugin per PR unless they're closely related |
| 90 | + |
| 91 | +## Testing locally |
| 92 | + |
| 93 | +You can test your plugin by pointing ECA to your local clone: |
| 94 | + |
| 95 | +```json |
| 96 | +{ |
| 97 | + "plugins": { |
| 98 | + "local": { "source": "/path/to/eca-plugins" }, |
| 99 | + "install": ["my-plugin"] |
| 100 | + } |
| 101 | +} |
| 102 | +``` |
| 103 | + |
| 104 | +## Questions? |
| 105 | + |
| 106 | +Open an issue or reach out on [Slack](https://join.slack.com/t/eca-dev/shared_invite/zt-34p6n16s1-_MwEJMr2F~gD2ol4gzntqw). |
0 commit comments