Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (31 loc) · 971 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (31 loc) · 971 Bytes
Raw

Contributing

Thanks for helping! Here's how to get started.

Setup

git clone https://github.com/RocketChat/Openclaw.git
cd Openclaw
corepack enable
pnpm install

Development

pnpm run build      # Compile TypeScript + bundle
pnpm run format     # Auto-format code
pnpm run setup      # Test with your own Rocket.Chat server (optional)

Before submitting a PR:

pnpm run build           # No errors?
pnpm run format:check    # Code styled?

Project Structure

  • src/cli/ — Setup wizard and commands
  • src/client/ — Rocket.Chat connection (DDP + REST)
  • src/service/ — Message handling and routing
  • src/plugin.ts — Plugin definition
  • docs/ — Architecture and guides

Submitting a PR

  • Code builds and formats cleanly
  • Changes tested manually (if adding features)
  • README updated (if user-facing change)

Questions? See ARCHITECTURE.md for how it all connects.