Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 959 Bytes

File metadata and controls

33 lines (22 loc) · 959 Bytes

Contributing to TextStream

Thanks for your interest in contributing to TextStream.

Getting started

  1. Fork the repo and clone your fork
  2. Create a virtual environment: python -m venv .venv && source .venv/bin/activate
  3. Install in development mode: pip install -e .
  4. Run the server: textstream

Making changes

  • Keep PRs focused on a single change
  • Follow the existing code style
  • Test your changes on Apple Silicon before submitting
  • Update the README if you change CLI flags, API endpoints, or default behavior

Reporting bugs

Open an issue with:

  • What you expected to happen
  • What actually happened
  • Your macOS version, chip (M1/M2/M3/M4), and Python version
  • The full error output

Feature requests

Open an issue describing the use case. Explain what you want to build and why the current API does not support it.

License

By contributing, you agree that your contributions will be licensed under the MIT License.