instructor/docs/contributing.md

We would love for you to contribute to Instructor.

Evals

We invite you to contribute evals in pytest as a way to monitor the quality of the openai models and the instructor library. To get started check out the jxnl/instructor/tests/evals and contribute your own evals in the form of pytest tests. These evals will be run once a week and the results will be posted.

Issues

If you find a bug, please file an issue on our issue tracker on GitHub.

To help us reproduce the bug, please provide a minimal reproducible example, including a code snippet and the full error message.

1. The response_model you are using.
2. The messages you are using.
3. The model you are using.

Pull Requests

We welcome pull requests! There is plenty to do, and we are happy to discuss any contributions you would like to make.

If it is not a small change, please start by filing an issue first.

If you need ideas, you can check out the help wanted or good first issue labels.

Contributors