Contributing

Contributing Guide

GoClaw is MIT-licensed and welcomes contributions of all kinds — bug fixes, new channel adapters, skill sidecars, documentation improvements, and design suggestions.

Development setup

bash

How to add a channel

  1. 1
    Create the channel adapter: Create internal/channels/yourplatform.go implementing the Channel interface (Start, Stop, Send methods).
  2. 2
    Register it: Add it to internal/channels/manager.go in the channel map.
  3. 3
    Add config fields: Add typed config fields in internal/config/config.go.
  4. 4
    Write docs: Add documentation in src/pages/docs/yourplatform.astro.
  5. 5
    Open a PR: Include a short demo video or screenshot showing the channel working end-to-end.
â„šī¸
Join the #contributing channel on Discord before starting a large PR — it's good to discuss the approach first and avoid duplicate work.

Commit conventions

GoClaw uses conventional commits. Every commit message should follow the format type(scope): message.

text