Skip to main content

Contributor Guide

img

Welcome to the Weaviate's Contributing Guide

If you’re using Weaviate or if you like the project, please ⭐ this repository to show your support!

Weaviate is a cloud-native, modular, real-time vector search engine.

Contributing to Weaviate​

🎉 First off, thank you for taking the time to contribute! 🎉

We are delighted to have you here. We are thrilled that you want to contribute to the Weaviate core, as together we can make Weaviate even better. We strive to build an engaging community and we encourage you to participate, share your ideas and make friends. As you become more acquainted with the community, there are several initiatives to consider, which are listed below. Everyone is welcome to join our Slack channel and interact with other members of the community.

Please change your Slack workspace display name to your name so that you can connect with other members more easily.

Recommend resources

Here are some resources that will help you familiarize with Weaviate and it's applications:

  • Weaviate Blogs – 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 of how to use the Weaviate.
  • Weaviate Examples – a repository of various examples projects created by the community. Each example shows a different Weaviate use case. You can add your own examples too!
  • Weaviate's YouTube Channel – this channel is about all Weaviate and vector search in general. You will find informative podcasts and live demonstration.

Join Weaviate Community

A lot of community communication happend at the Weaviate Community Slack. Everyone is welcome to join.

To get involved in our community, please make sure you to familiarise yourself with the project's Code of Conduct.

We understand that navigating a new open source project can be difficult, and that it takes time to become acquainted with the code base. If at any point of time, you face any difficulties, don't hesitate to ask in the #general channel on our Slack. Our team and the community will help you solve your problem.

Reach out to members of the community, introduce yourself, and share your ideas/doubts. Tell them about your areas of interest and what technologies you are using to build your projects. The more they know about you, the better they will be able to match project requirements to your interests and abilities.