Community guidelines for contributing to Weam AI through bug reports, feature development, documentation, and community engagement.

​
Ways to Contribute

​
Development Contributions

​
Documentation & Design

  • Documentation: Improve unclear or outdated documentation
  • UI/UX: Enhance user interface and experience design
  • Translation: Make Weam AI accessible in additional languages

​
Community Support

  • Testing & Feedback: Test new features and provide detailed feedback
  • Community Help: Assist other users in discussions and forums

​
Community Resources

​
Communication Channels

​
Guidelines

  • Code of Conduct: Community standards
  • Contribution Guidelines: Follow project standards for pull requests
  • Issue Templates: Use provided templates for consistent reporting

​
Getting Started

​
For New Contributors

  1. Read the Documentation: Start with our introduction.
  2. Set Up Development Environment: Follow the local setup guide for Docker-based development
  3. Understand the Architecture: Review system design and workflows
  4. Fork the Repository: Create your own copy of the project
  5. Choose an Issue: Start with “good first issue” labels
  6. Submit Pull Request: Follow project guidelines for code contributions

​
Development Resources

​
Technical Documentation

​
Integration Guides

​
Development Workflows

​
Quick Start Commands

# Clone the repository
git clone https://github.com/weam-ai/weam.git
cd weam

# Set up environment
cp .env.example .env

# Start development environment
docker compose up --build

# Access the application
open http://localhost:3000

​
Development Environment

  • Frontend: Next.js on port 3000
  • Node.js API: Express.js on port 4050
  • Python API: FastAPI on port 9089
  • Development URLs: See development guide for complete service URLs

​
Recognition

Contributors are recognized through:
  • GitHub contributor listings
  • Community acknowledgments
  • Project documentation credits
Thank you for being part of the Weam AI community! 💙