Contributing

Rig is an open-source project and we welcome contributions from the community. Whether you’re a developer, designer, or writer, there are many ways to contribute to the project. The section below outlines the different areas where your help is most needed.

Note

Prior to starting the work on a new feature or change, make sure to search for existing issues and pull requests on the GitHub repository to discuss your ideas or changes. Open an issue if there is none.

Development

Model provider integrations

Rig aims to support a wide range of language models from different providers. If your favorite model provider is not supported, consider adding support for it in Rig and making a pull request for it!

Important information about model provider integrations:

• Each model provider integration is contained in its own module under rig-core/src/providers.
• If the provider has an OpenAI compatible API, there is no need to write a new provider module since Rig already supports OpenAI. Instead, you can simply add documentation indicating how you can use the existing openai integration to use the new provider.
• Make sure to follow the repository’s contribution guidelines.

Caution

Model provider integrations should not require new dependencies that are not already included in the project.

Vector store integrations

Rig aims to support a wide range of vector stores for storing and retrieving embeddings. If your favorite vector store is not supported, consider adding support for it in Rig and making a pull request for it!

Important information about vector store integrations:

• Each vector store integration is contained in its own crate located in the root of the repository. The naming convention for vector store crates is rig-<store_name> (e.g. rig-mongodb). This is because vector store integrations often require many additional dependencies that are not needed otherwise.
• Consider adding an integration test for the integration! You can base yourself off of the existing vector store integration tests like this one for Qdrant.
• Make sure to follow the repository’s contribution guidelines.

Bug fixes

If you find a bug in Rig, please open an issue for it on the repository and consider making a pull request to fix it.

Make sure to follow the repository’s contribution guidelines.

Documentation

Guides and tutorials

If you have experience with Rig and would like to share your knowledge with others, consider writing a guide or tutorial for the project!

If you would like your tutorial to be featured on this website, please open a pull request on the site repository.

Other documentation improvements

If you find a typo or mistake in the documentation, or any section that could use improvement, please open an issue to report it or a pull request to fix it on the site repository. The documentation app also has a CONTRIBUTING.md file that you may find useful for understanding how to get the repo working locally.

Ideas and feedback

If you have an idea for a new Rig feature or feedback on existing features, please let us know by opening an issue on the GitHub repository!

Make sure to check out the existing issues first to make sure your idea is not already planned or in progress.