At Weaviate, we love open source! Join us in celebrating Hacktoberfest, a month-long celebration of open source! Participants with four pull requests (PR) accepted between October 1 - 31, 2023 will receive a unique digital reward from Hacktoberfest.
The Task
Welcome to our demo sprint!
It is aimed at onboarding engineers and machine learning practitioners to open-source. In our example use cases and demos page, we showcase what you can do with a vector database. Some of these demos have received more love than others recently, and we want to give them a little polish.
The gallery contains demos using Weaviate in different states. Here is an example of a demo project in a good state. While some may only need a little polish of the description (README.md file), others are e.g., a little older or can use a little makeover for the user interface.
The steps to your first Hacktoberfest PR are simple:
- Find an issue you're interested in: Go to the example use cases and demos page and select a project marked for Hacktober with a 🎃 sign. Click on “code” to get to the repository and have a look at its issues.
- Ping us on the project’s issue, saying you're interested and which parts of the issue you would like to contribute to.
- Open the PR as instructed in the Weaviate Contributor Guide. We will review and help you out in the process. 💚
You can also contribute by adding your own Weaviate examples. If you have other great ideas for contributions, let us know on our Discourse and Slack channels, and we will figure out how to highlight it in Hacktoberfest.
You don't need to be an expert to contribute to these demo projects!
Resources to Get Started
We're thrilled to help you make your first open-source contribution! Here are some helpful resources to kickstart your journey:
What is Open Source, and how do you contribute to it?
- 🎯 What is Open Source
- 🎯 Introduction to GitHub and Open-Source Projects
- 🎯 How to Contribute to Open Source
- 🎯 GitHub Contribution Guide by Hugging Face
- 🎯 How to Use Git
- 🎯 Weaviate Contributor Guide
If you're new to Weaviate, get up and running quickly with these beginner-friendly guides:
Dive deeper into specific topics with these detailed guides:
- How-to Search Guides 🔍
- Keyword, Vector, Hybrid, and Generative Search 🔍
- How-to Manage Data (CRUD Operations) 💾
- Tutorial: Importing Data with Your Own Vectors 📊
- Weaviate Architecture Concepts 🏛️
Join one of our workshops for an introduction to Weaviate.
- 4th October 2023 (20:00-21:00 UTC+2): Introduction to Weaviate with Zain Hasan, Senior Dev Advocate @ Weaviate
- 5th October 2023 (17:00-18:00 UTC+2): NEW Python
CollectionsClient API Preview with JP Hwang - Educator @ Weaviate - 18th October 2023 (15:00-16:00 UTC+2): Introduction to Weaviate with JP Hwang - Educator @ Weaviate
Expand your knowledge with these supplementary resources:
What's in it for you?
The repositories you contribute to participate in Hacktoberfest and are a great opportunity for your first-ever Hacktoberfest PR. We will also assist you throughout the whole process.
You might even receive some swag in the end.
Connect with the Weaviate Community!
To make your Hacktoberfest experience successful, connect with the Weaviate community for collaboration and assistance. You can reach us through:
- Join our dedicated Hacktoberfest channel in our Discourse community forum, where we're ready to answer your questions.
- Join our dedicated #hacktoberfest channel in our Weaviate Community Slack channel to stay connected and receive real-time support.
- Join our newsletter and follow us on Twitter and Linkedin to receive updates.
- Stay up to date with Weaviate's development by exploring the Weaviate GitHub Repository. Don’t forget to give us a ⭐️ while you are there!
FAQ
- Will this count towards Hacktoberfest? Yes, it definitely does! If your PR/MR is created between October 1 and October 31 (in any time zone, UTC-12 thru UTC+14), we will add the "HACKTOBERFEST-ACCEPTED" label to it.
- Where do I get help? For any questions or assistance, contact us on our Discourse and Slack channels.
- I have a cool contribution idea. Can I still participate? Awesome! Connect with us on our Discourse or Slack channels and we will figure it out.
- I don’t know how to write code. Can I still contribute? Yes, of course! You can make no-code contributions, e.g., by updating the README.md files. If you want to learn how to write code with a concrete example, we can help you find a good issue. Just ping us on our Discourse or Slack channels.
Happy hacking, and let's make Hacktoberfest 2023 a memorable one together! 🚀
Jump right in and have a look at our example use cases and demos page.
Ready to start building?
Check out the Quickstart tutorial, and begin building amazing apps with the free trial of Weaviate Cloud Services (WCS).