Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
96 lines (71 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

96 lines (71 loc) · 3.42 KB

Contributing to Clawith 🦞

Thanks for your interest in contributing! Whether it's a bug fix, new feature, translation, or documentation improvement — every contribution matters.

Quick Start

  1. Fork this repo and clone your fork
  2. Set up the dev environment: 
    bash setup.sh    # Backend + frontend + database
bash restart.sh  # Start services → http://localhost:3008
  3. Create a branch: git checkout -b my-feature
  4. Make your changes
  5. Push and open a Pull Request

What Can I Contribute?

Area Examples
🐛 Bug fixes UI glitches, API errors, edge cases
✨ Features New agent skills, tools, UI improvements
🔧 MCP Integrations New MCP server connectors
🌍 Translations New languages or improving existing ones
📖 Documentation README, guides, code comments
🧪 Tests Unit tests, integration tests

New to the project? Look for issues labeled good first issue.

Bug Reports

When reporting a bug, please include:

  • Steps to reproduce
  • Expected vs actual behavior
  • Clawith version and deployment method (Docker / Source)
  • Logs or screenshots if available

Priority guide:

Type Priority
Core functions broken (login, agents, security) 🔴 Critical
Non-critical bugs, performance issues 🟡 Medium
Typos, minor UI issues 🟢 Low

Feature Requests

Please describe:

  • The problem you're trying to solve
  • Your proposed solution (if any)
  • Why this would be useful

Pull Request Process

  1. Link an issue — Create one first if it doesn't exist
  2. Keep it focused — One PR per feature/fix
  3. Test your changes — Make sure nothing is broken
  4. Follow code style:
    • Backend: Python — formatted with ruff
    • Frontend: TypeScript — standard React conventions
  5. Use Fixes #<issue_number> in the PR description

Project Structure

backend/
├── app/
│   ├── api/          # FastAPI route handlers
│   ├── models/       # SQLAlchemy models
│   ├── services/     # Business logic
│   └── core/         # Auth, events, middleware
frontend/
├── src/
│   ├── pages/        # Page components
│   ├── components/   # Reusable UI components
│   ├── stores/       # Zustand state management
│   └── i18n/         # Translations

Language Policy

To ensure all contributors can participate effectively, please use English for issues, PRs, and code comments.

为了确保所有贡献者都能有效参与，请使用英语提交 Issue、PR 和代码注释。

すべてのコントリビューターが効果的に参加できるよう、Issue、PR、コードコメントは英語でお願いします。

모든 기여자가 효과적으로 참여할 수 있도록, Issue, PR, 코드 코멘트는 영어로 작성해 주세요.

Para garantizar que todos los contribuidores puedan participar de manera efectiva, utilice inglés para issues, PRs y comentarios de código.

لضمان مشاركة جميع المساهمين بفعالية، يرجى استخدام اللغة الإنجليزية في الـ Issues وطلبات السحب وتعليقات الكود.

Getting Help

Stuck? Open a Discussion or ask in the related issue. We're happy to help! 🙌