Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (56 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

78 lines (56 loc) · 2.3 KB

Contributing to MultiWA

First off, thank you for considering contributing to MultiWA! It's people like you that make MultiWA such a great tool.

Code of Conduct

This project and everyone participating in it is governed by the MultiWA Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead
  • Include logs if possible

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • Use a clear and descriptive title
  • Provide a step-by-step description of the suggested enhancement
  • Explain why this enhancement would be useful

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code lints
  6. Issue that pull request!

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/multiwa.git
cd multiwa

# Install dependencies
pnpm install

# Start development
pnpm dev

Project Structure

multiwa/
├── apps/
│   ├── api/          # NestJS API backend
│   └── admin/        # Next.js admin dashboard
├── packages/
│   ├── database/     # Prisma schema & migrations
│   ├── engines/      # WhatsApp engine adapters
│   ├── sdk/          # TypeScript SDK
│   ├── sdk-python/   # Python SDK
│   └── sdk-php/      # PHP SDK
└── docs/             # Documentation

Coding Style

  • Use TypeScript for all new code
  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Write tests for new features

License

By contributing, you agree that your contributions will be licensed under the MIT License.