Thanks for your interest in contributing! Here's how to get started.
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR-USERNAME/REPO-NAME.git - Create a branch:
git checkout -b my-feature - Make your changes
- Push:
git push origin my-feature - Open a Pull Request
python -m venv .venv
source .venv/bin/activate # or .venv\Scripts\activate on Windows
pip install -e ".[dev]"- Write tests for new features
- Run existing tests before submitting:
pytest - Follow PEP 8 style conventions
- Keep PRs focused — one feature or fix per PR
- Write clear commit messages
- Use GitHub Issues
- Include steps to reproduce
- Include expected vs actual behavior
- Include Python version and OS
Be respectful, constructive, and inclusive. We're all here to build good tools.