# Contributing to Empathy Framework Thank you for your interest in contributing to the Empathy Framework! This document provides guidelines and best practices for contributing. ## Table of Contents - [Code of Conduct](#code-of-conduct) - [Getting Started](#getting-started) - [Development Workflow](#development-workflow) - [Testing](#testing) - [Code Standards](#code-standards) - [Documentation](#documentation) - [Pull Request Process](#pull-request-process) ## Code of Conduct We are committed to providing a welcoming and inclusive environment. Please be respectful and professional in all interactions. ## Getting Started ### Prerequisites - Python 3.10 or higher - pip (Python package manager) - git ### Setup Development Environment ```bash # Clone the repository git clone https://github.com/Deep-Study-AI/Empathy.git cd Empathy # Create virtual environment python3 -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate # Install in development mode pip install -e . # Install development dependencies pip install pytest pytest-cov pytest-asyncio # Run tests to verify setup pytest tests/ ``` ## Development Workflow ### Branch Strategy - `main` - Stable releases - `develop` - Development branch - `feature/*` - New features - `fix/*` - Bug fixes - `docs/*` - Documentation updates ### Creating a Feature ```bash # Create feature branch from develop git checkout develop git pull origin develop git checkout -b feature/your-feature-name # Make your changes # ... # Commit with clear messages git add . git commit -m "feat: Add anticipatory pattern detection - Implement trajectory analysis - Add tests for edge cases - Update documentation" # Push to your fork git push origin feature/your-feature-name ``` ### Commit Message Format We follow conventional commits: ``` :