CONTRIBUTING.md

Contributing to AI Agency Pro

Thank you for your interest in contributing to AI Agency Pro! This document provides guidelines and instructions for contributing.

Getting Started

Prerequisites

• Python 3.9 or higher
• Git
• A Hugging Face account (for testing Space deployment)

Local Development Setup

1. Clone the repository

   git clone https://huggingface.co/spaces/dlynch90/AI-Agency-Pro
   cd AI-Agency-Pro
   

2. Create a virtual environment

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

3. Install dependencies

   pip install -r requirements.txt
   pip install -r requirements-dev.txt  # Development dependencies
   

4. Set up pre-commit hooks

   pip install pre-commit
   pre-commit install
   

Development Workflow

Code Style

We follow these code style guidelines:

• Black for code formatting (line length: 127)
• isort for import sorting (black profile)
• flake8 for linting
• Type hints are encouraged for all functions

Run formatters before committing:

black .
isort .
flake8 .

Running Tests

# Run all tests
pytest tests/ -v

# Run only unit tests
pytest tests/ -v -m unit

# Run with coverage
pytest tests/ -v --cov=. --cov-report=html

Making Changes

1. Create a new branch for your feature or fix
2. Write tests for new functionality
3. Update documentation if needed
4. Run the test suite to ensure nothing is broken
5. Submit a pull request with a clear description

Pull Request Guidelines

Before Submitting

• All tests pass locally
• Code follows the project's style guidelines
• Documentation is updated (if applicable)
• Commit messages are clear and descriptive

PR Description Template

Please include:

• What changes were made
• Why the changes were needed
• How to test the changes

Reporting Issues

When reporting bugs, please include:

1. Environment (Python version, OS, browser if applicable)
2. Steps to reproduce the issue
3. Expected behavior vs actual behavior
4. Error messages or screenshots if available

Code of Conduct

Please be respectful and inclusive in all interactions. We follow the Contributor Covenant code of conduct.

Questions?

Feel free to open an issue for questions or reach out through the Community tab on Hugging Face.

---

Thank you for contributing to AI Agency Pro!