> ## Documentation Index
> Fetch the complete documentation index at: https://opensource.weam.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Contributions

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

## Ways to Contribute

### Development Contributions

* **Bug Reports**: [Open an issue](https://github.com/weam-ai/weam/issues/new?template=bug_report.md)
* **Feature Requests**: [Submit a feature request](https://github.com/weam-ai/weam/issues/new?template=feature_request.md)
* **Issue Resolution**: Check [open issues](https://github.com/weam-ai/weam/issues) and submit fixes
* **Code Improvements**: Optimize performance, refactor code, add tests

### 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

* **GitHub Discussions**: [Project discussions](https://github.com/weam-ai/weam/discussions)
* **Discord**: [Community chat](https://discord.gg/EyUbyUxf4n)
* **Twitter**: [@weamai](https://x.com/TheWeamAI) for updates

### Guidelines

* **Code of Conduct**: [Community standards](https://github.com/weam-ai/weam?tab=coc-ov-file)
* **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](https://opensource.weam.ai/docs/overview/Introduction.md).
2. **Set Up Development Environment**: Follow the [local setup guide](https://opensource.weam.ai/docs/setup/choose-your-setup/local-setup.md) for Docker-based development
3. **Understand the Architecture**: Review [system design](https://opensource.weam.ai/docs/essentials/system-design.md) and [workflows](https://opensource.weam.ai/docs/essentials/workflows/llm-query.md)
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

* [**System Design**](https://opensource.weam.ai/docs/essentials/system-design.md): Full-stack architecture overview
* [**Database Functions**](https://opensource.weam.ai/docs/essentials/common-functions/database-functions.md): MongoDB repository patterns
* [**Environment Setup**](https://opensource.weam.ai/docs/setup/after-setup-complete/environment-variables.md): Complete environment variable reference

#### Integration Guides

* [**LLM Model Integration**](https://opensource.weam.ai/docs/essentials/workflows/model): Add new language models
* [**Agent Development**](https://opensource.weam.ai/docs/essentials/workflows/agent.md): Build custom AI agents
* [**MCP Connections**](https://opensource.weam.ai/docs/essentials/workflows/mcp-workflow.md): Integrate third-party services

#### Development Workflows

* [**Simple Chat**](https://opensource.weam.ai/docs/essentials/workflows/simple-chat.md): Basic chat implementation
* [**RAG Chat**](https://opensource.weam.ai/docs/essentials/workflows/rag-chat.md): Document-based conversations
* [**LangGraph Integration**](https://opensource.weam.ai/docs/essentials/workflows/langgraph.md): Streaming chat setup

### Quick Start Commands

```bash theme={null}
# 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
* **Development URLs**: See [development guide](https://opensource.weam.ai/docs/setup/after-setup-complete/launch-verify.md) 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! 💙


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.