Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (51 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

66 lines (51 loc) · 1.71 KB
Raw

Contributing

Thanks for your interest in contributing to this plugin marketplace!

Adding a New Plugin

  1. Create a plugin directory under plugins/:

    mkdir -p plugins/your-plugin/.claude-plugin

  2. Add plugin metadata in .claude-plugin/plugin.json:

    {
  "name": "your-plugin",
  "description": "What your plugin does",
  "version": "1.0.0",
  "author": { "name": "Your Name" }
}

  3. Add plugin files (commands, hooks, etc.) to the plugin root directory

  4. Update .claude-plugin/marketplace.json to include your plugin

  5. Test locally:

    /plugin marketplace add ./claude-plugins
/plugin install your-plugin@cosmictaco-marketplace

Plugin Structure

plugins/your-plugin/
├── .claude-plugin/
│   └── plugin.json      (Required: plugin metadata)
├── commands/            (Optional: slash commands)
├── agents/              (Optional: custom agents)
├── hooks/               (Optional: event hooks)
│   └── hooks.json
├── skills/              (Optional: agent skills)
└── README.md            (Optional: plugin documentation)

Guidelines

  • Keep plugins focused and single-purpose
  • Document what your plugin does in README.md
  • Test thoroughly before submitting
  • Follow semantic versioning for plugin versions
  • Ensure proper error handling (especially for hooks)

Reporting Issues

Found a bug or have a suggestion? Open an issue with:

  • Clear description of the problem
  • Steps to reproduce (for bugs)
  • Expected vs actual behavior
  • Your environment (Claude Code version, OS, etc.)

Code Style

  • Python: Follow PEP 8
  • JSON: Use 2-space indentation
  • Keep code readable and well-commented