Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
71 lines (52 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 1.27 KB
Raw

Contributing to ExplainFlow

Thank you for your interest in contributing to ExplainFlow! 🎉

Development Setup

  1. Clone the repository:
git clone https://github.com/yourusername/explainflow.git
cd explainflow
  1. Create a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install in development mode:
pip install -e ".[all]"

Running Tests

pytest

With coverage:

pytest --cov=explainflow --cov-report=html

Code Style

We use:

  • Black for code formatting
  • Ruff for linting
  • MyPy for type checking

Run all checks:

black src tests
ruff check src tests
mypy src

Pull Request Process

  1. Fork the repo and create your branch from main
  2. Add tests for any new functionality
  3. Ensure all tests pass
  4. Update documentation as needed
  5. Submit a pull request

Reporting Issues

Please use the GitHub issue tracker and include:

  • Python version
  • ExplainFlow version
  • Minimal code to reproduce the issue
  • Expected vs actual behavior

Feature Requests

We welcome feature requests! Please check existing issues first to avoid duplicates.

Code of Conduct

Be kind, respectful, and constructive. We're all here to learn and improve.