First off, thanks for taking the time to contribute! 🎉
We welcome contributions of all kinds, including bug reports, feature requests, documentation improvements, and code changes.
If you find a bug, please create a new issue. Be sure to include:
- A clear, descriptive title.
- Steps to reproduce the issue.
- Expected vs. actual behavior.
- Your operating system and Python version.
We love new ideas! If you have a feature request, please open an issue and describe:
- The problem you're trying to solve.
- Your proposed solution or feature.
- Any alternative solutions you've considered.
- Fork the repository and clone it locally.
- Create a new branch for your feature or bug fix:
git checkout -b feature/amazing-new-feature
- Install dependencies (we recommend using
uv):uv sync
- Make your changes. Please ensure your code follows the existing style.
- Run tests to ensure you haven't broken anything:
python -m pytest tests/
- Commit your changes with descriptive commit messages.
- Push to your fork and submit a Pull Request!
We use uv for dependency management.
# Install uv
pip install uv
# Create virtual env and install dependencies
uv sync
# Run the CLI locally
uv run gen-tts --helpPlease be respectful and kind to others. We strive to maintain a welcoming and inclusive community.