Contributing

Join the Movement

DressClaw is open source. Every contribution counts: outfits, code, documentation, ideas.

Ways to Contribute

Create Outfits

Design and share new outfits for your domain: trading, development, research, operations, and more.

Write Code

Improve the CLI, engine, bridge, or schema. Fix bugs, add features, optimize performance.

Write Documentation

Improve guides, add examples, translate content, or write tutorials for new users.

Share Ideas

Open issues, join discussions, propose new features, or give feedback on the standard.

Creating an Outfit

The fastest way to contribute is by creating a new outfit. An outfit packages an agent's complete operational behavior into a shareable, reusable unit.

  1. Fork the DressClaw repository and clone it locally.
  2. Run dressclaw new my-outfit to scaffold the directory structure.
  3. Edit outfit.yaml with your agent's soul, crons, flows, skills, and model configuration.
  4. Write the SOUL.md file with the agent's identity and personality.
  5. Add any Lobster flow files in the flows/ directory.
  6. Validate with dressclaw lint and test with dressclaw wear.
  7. Submit a pull request to the community outfits directory.
Tip: Use dressclaw eject trader to start from an existing official outfit and customize it. This is often faster than starting from scratch.

Contributing Code

To contribute to the DressClaw codebase, follow the standard fork-and-PR workflow.

Local Setup

$ git clone https://github.com/Conradlog/dressclaw.git
$ cd dressclaw && npm install
$ npm run dev

Guidelines

  • Write clear, descriptive commit messages that explain the "why" not just the "what".
  • Add tests for new features and bug fixes. Run the full test suite before submitting.
  • Follow the existing code style. The project uses ESLint and Prettier for consistency.
  • Keep PRs focused. One feature or fix per pull request.
  • Update documentation when your changes affect the public API or CLI commands.
  • Be respectful in code reviews. Every contribution makes the ecosystem better.

Translations

DressClaw supports 9 languages. Help us improve translations or add new ones. Translation strings are stored as JSON objects in each HTML page's script section.

Supported languages: English, Italian, Chinese, Spanish, French, German, Japanese, Portuguese, Korean. If your language is not listed, open an issue to propose adding it.

Code of Conduct

We are committed to providing a welcoming and inclusive environment. All contributors are expected to adhere to the project's code of conduct. Be kind, constructive, and respectful.

Report any concerns to the maintainers. We take all reports seriously and will act on them promptly.