Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
121 lines (87 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

121 lines (87 loc) · 2.73 KB

Contributing to Docker MCP Plugin for Clawdbot

Thank you for your interest in contributing! This plugin is community-driven and welcomes contributions of all kinds.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with:

  • A clear, descriptive title
  • Steps to reproduce the problem
  • Expected vs actual behavior
  • Your environment (OS, Docker version, Clawdbot version)
  • Relevant logs or error messages

Suggesting Features

We welcome feature suggestions! Please:

  • Check existing issues to avoid duplicates
  • Describe the use case and why it would be valuable
  • Provide examples if possible

Pull Requests

  1. Fork the repository

    git clone https://github.com/clawdbot/docker-mcp-plugin.git
cd docker-mcp-plugin

  2. Create a feature branch

    git checkout -b feature/your-feature-name

  3. Make your changes

    • Follow the existing code style
    • Add comments for complex logic
    • Update documentation if needed

  4. Test your changes

    # Install the plugin locally
clawdbot plugins install .

# Test with Clawdbot
clawdbot chat

  5. Commit with clear messages

    git commit -m "Add feature: brief description"

  6. Push and create a PR

    git push origin feature/your-feature-name

Code Style

  • Use TypeScript with proper type annotations
  • Follow existing naming conventions
  • Keep functions focused and single-purpose
  • Add JSDoc comments for public APIs

Plugin Structure

docker-mcp-plugin/
├── clawdbot.plugin.json   # Plugin metadata and config schema
├── package.json            # NPM package configuration
├── index.ts                # Main entry point
├── src/
│   ├── docker-mcp-client.ts   # MCP client wrapper
│   └── docker-mcp-tools.ts    # Tool registration and conversion
└── test/                   # Tests (if any)

Development Setup

# Install dependencies
npm install

# Link for local development
npm link

# Install in Clawdbot
clawdbot plugins install /path/to/docker-mcp-plugin

Testing

Before submitting a PR:

  1. Test basic Docker operations (list containers, images, etc.)
  2. Test error handling (disconnection, invalid commands)
  3. Verify config options work as expected
  4. Check logs for any warnings or errors

Documentation

When adding features, please update:

  • README.md - User-facing documentation
  • clawdbot.plugin.json - Config schema if adding options
  • JSDoc comments in code
  • Examples in README if applicable

Questions?

Feel free to:

  • Open an issue for discussion
  • Join the Clawdbot community Discord
  • Tag maintainers in your PR for review

Thank you for contributing! 🐾