Thank you for considering contributing! This document outlines the guidelines.
- Fork the repository and clone your fork.
- Install dependencies:
pip install -r requirements.txt. - Create a feature branch:
git checkout -b feature/your-feature.
- Follow PEP 8 style conventions.
- Write tests for new features in the
tests/directory. - Run existing tests:
python -m pytest tests/ -v. - Update
README.mdif adding user-facing functionality.
Use conventional commits: feat:, fix:, docs:, chore:, refactor:, test:.
- Keep PRs focused on a single concern.
- Reference any related issues in the description.
- Ensure all CI checks pass before requesting review.
Be respectful, inclusive, and constructive.