Contributing to AgentCrew

Contributing to AgentCrew

Thank you for your interest in contributing to AgentCrew! 🎉 We're excited to collaborate with you and appreciate contributions of all kinds, no matter how small. AgentCrew is a community-driven project, and your participation helps make it better for everyone.

🌟 Ways to Contribute

We welcome various types of contributions:

• Bug Reports: Help us identify and fix issues
• Feature Requests: Suggest new functionality or improvements
• Code Contributions: Fix bugs, implement features, or improve performance
• Documentation: Improve guides, add examples, or fix typos
• Testing: Write tests, report test failures, or improve test coverage
• UI/UX Improvements: Enhance the GUI or CLI experience
• Agent Development: Create new agents or improve existing ones
• Tool Integration: Add support for new tools and services

🚀 Getting Started

Prerequisites

• Python 3.8 or higher
• Git
• Basic understanding of AI/LLM concepts (helpful but not required)

Development Environment Setup

1. **Get the code:**

   git clone https://github.com/saigontechnology/AgentCrew.git
   cd AgentCrew

2. **Set up a Python environment:**

   uv sync
   uv run AgentCrew/main.py chat

3. **Configure API Keys** (for testing)

   • Copy the example configuration file
   • Add your test API keys (use test/sandbox keys when possible)

Running Tests

# Run all tests
python -m pytest

# Run specific test file
python -m pytest tests/test_specific_module.py

# Run with coverage
python -m pytest --cov=AgentCrew --cov-report=html

Code Quality Checks

Before submitting your contribution, ensure your code passes quality checks:

# Code formatting (if using black)
black AgentCrew/ tests/

# Linting (if using flake8 or ruff)
flake8 AgentCrew/ tests/

# Type checking (if using mypy)
mypy AgentCrew/

🐛 Reporting Issues

When reporting bugs, please include:

• Clear Description: What you expected vs. what happened
• Steps to Reproduce: Detailed steps to recreate the issue
• Environment Details: OS, Python version, AgentCrew version
• Error Messages: Full error traceback if available
• Configuration: Relevant parts of your config (remove sensitive data)

**Use our issue template when available** - it helps us understand and resolve issues faster.

💡 Suggesting Features

For feature requests:

• Check existing issues first to avoid duplicates
• Describe the problem your feature would solve
• Explain your proposed solution with examples if possible
• Consider alternatives and mention any you've explored
• Discuss impact on existing functionality

🔧 Development Guidelines

Code Style

• Follow PEP 8 Python style guidelines
• Use meaningful variable and function names
• Keep functions focused and reasonably sized
• Add docstrings to classes and functions
• Use type hints where appropriate

Archi