We would love for you to contribute to Instructor-js.

Migrating Docs from Python¶

Theres a bunch of examples in the python version, including documentation here python docs

If you want to contribute, please check out issues

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.

This projectuses Bun & Typescript.

Ensure you have the correct versions of all required runtimes/tools. This project uses a .tool-versions file at the root of the repository. If you have asdf (a universal version manager), it should automatically pick up the required versions.

Install Dependencies: Run the following command to install the project dependencies:

bun install

Environment Variables: Copy the .example.env file to .env and fill in the necessary values for the OpenAI and Anyscale keys.

This project uses ESLint and Prettier for code formatting and quality checks.
Prettier is integrated with ESLint, so it's recommended to use an ESLint plugin in your IDE.
For Visual Studio Code or Cursor users: Project-level settings are configured to enable ESLint autosave.

The IDE should prompt you to install recommended plugins.

*Note: If using the Prettier plugin, ensure it's disabled to avoid conflicts.

bun test

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.

If your PR includes changes to the source code, include a changeset.
Changesets help manage and automate versioning.
Create a changeset by running bun changeset at the root of the project and following the prompts.
Be descriptive in the changeset as it will be included in the changelog for the next release.
Choose patch, minor, or major for your changeset depending on the type of change.
Commit the changeset file (an auto-generated markdown file describing the changes). This will trigger a CI action once merged and stack the change on top of any existing ones in preparation for the next release.

For more information on changesets, visit: Changesets GitHub Repository

Python is required to run the documentation locally using mkdocs.

To enhance your understanding of the documentation, here are some useful references:

mkdocs serve: The mkdocs serve command is used to preview your documentation locally during the development phase. When you run this command in your terminal, MkDocs starts a development server, allowing you to view and interact with your documentation in a web browser. This is helpful for checking how your changes look before publishing the documentation. Learn more in the mkdocs serve documentation.
hl_lines in Code Blocks: The hl_lines feature in code blocks allows you to highlight specific lines within the code block. This is useful for drawing attention to particular lines of code when explaining examples or providing instructions. You can specify the lines to highlight using the hl_lines option in your code block configuration. For more details and examples, you can refer to the hl_lines documentation.
Admonitions: Admonitions are a way to visually emphasize or call attention to certain pieces of information in your documentation. They come in various styles, such as notes, warnings, tips, etc. Admonitions provide a structured and consistent way to present important content. For usage examples and details on incorporating admonitions into your documentation, you can refer to the admonitions documentation.

For more details about the documentation structure and features, refer to the MkDocs Material documentation.

Thank you for your contributions, and happy coding!