Skip to content

Contributing to Amebo

Thank you for your interest in contributing to Amebo! This guide will help you get started.

Development Setup

  1. Fork and Clone 

    git clone https://github.com/YOUR_USERNAME/amebo.git
cd amebo

  2. Install Dependencies 

    python -m venv venv
source venv/bin/activate
pip install -e .
pip install -r requirements-dev.txt

  3. Run Tests 

    pytest

Code Style

  • Follow PEP 8
  • Use type hints
  • Write docstrings
  • Maximum line length: 88 characters

Submitting Changes

  1. Create a feature branch
  2. Make your changes
  3. Add tests
  4. Update documentation
  5. Submit a Pull Request

Getting Help

  • GitHub Discussions for questions
  • GitHub Issues for bugs
  • Check documentation first

Thank you for contributing! 🎉