Getting Started

License badge Weaviate on Stackoverflow badge Weaviate issues on Github badge Weaviate v1.16.5 version badge Weaviate v1.16.5 version badge Weaviate total Docker pulls badge

To help you get started contributing to Weaviate.


Introduction

Welcome! Working with Weaviate, many of us in the team and the community are exposed to a suite of interesting technologies. They include not only vector search engines, but also Docker, Kubernetes, GraphQL, REST and clients in various languages.

This means that is a wide set of opportunities for you to learn about and contribute to! If you are not sure where, we suggest finding something that overlaps with your interests

How can I contribute?

These are just some of the ways that you could apply your skills to the project:

Where can I contribute to?

There are four major GitHub repositories of Weaviate, any of which you can contribute to. This includes:

It is important that any contributions such as suggestions or bug reports be made to the correct repository, as they will be otherwise very difficult to understand or integrate.

Work on existing issues

You can also contribute by working on existing issues at any of Weaviate’s repositories in GitHub, such as Weaviate core. You could start with issues tagged ‘good first issues’, for instance.

Background reading

Navigating a new project can be difficult, and it takes time to become acquainted with the codebase. If you haven’t yet, we suggest going through the Weaviate getting started guide.

Here are additional resources that will help you familiarize with Weaviate and its applications:

  • Weaviate Blog – a series of blog around Weaviate and the overall vector search space.
  • Weaviate Newsletter – bi-weekly newsletter with updates on the latest and greatest announcements.
  • Awesome Weaviate – a list of curated examples and tutorials on how to use Weaviate.
  • Weaviate Examples – a repository of various example projects created by the community. Each example shows a different Weaviate use case. You can add your own examples too!
  • Weaviate’s YouTube Channel – podcasts and live demos showcasing Weaviate, and providing insight into the vector search space in general.

Learn about git / GitHub

Like many other open-source projects, the Weaviate community uses the git/GitHub ecosystem for collaborative development. If you are not familiar with git and GitHub basics, we have a guide on how to contribute to Weaviate with git and GitHub.

Regardless of your choice, we are very excited to have you be a part of our community. Welcome 🙂.