22 lines (15 loc) · 939 Bytes

Contributing

Thanks for your interest in this project. This is a portfolio/showcase repository.

How to contribute

Fork the repo and create a branch for your change.
Code — Keep style consistent with the existing codebase (Python, type hints where helpful).
Test — If you add features, consider adding tests; ensure the API still runs with python main.py.
Document — Update README or docs if you change behavior or add options.
Open a Pull Request with a clear description of what you changed and why.

Setup for development

Python 3.9+
Create a virtual environment, install from requirements.txt.
Copy .env.example to .env and set placeholder values (support API calls will fail without real credentials).
Place or train a model in models/current_model and models/current_tokenizer to run the API.

Questions

Open an issue for bugs, feature ideas, or questions.