Skip to content

Commit cce39a9

Browse files
author
lizhe
committed
docs: Add GSoC 2026 documentation
1 parent fb84ded commit cce39a9

File tree

3 files changed

+120
-0
lines changed

3 files changed

+120
-0
lines changed

community/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# AutoMQ Community
2+
3+
Welcome to the AutoMQ community! This directory contains community-related resources and programs.
4+
5+
## Contents
6+
7+
- [GSoC 2026 (Google Summer of Code)](./gsoc/2026/) - Information about AutoMQ's participation in GSoC 2026
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# AutoMQ Project Ideas
2+
3+
If you are a GSoC candidate, please check out our **Contributor Guidance** to learn more about our project requirements, communication channels, and how to submit a successful proposal.
4+
5+
If a project is successfully selected, you will be allocated a primary mentor and supported by the rest of the team. If you are interested in learning more about a particular project idea please contact us using kaiming.wan@automq.com or on our [AutoMQ Slack channel](https://go.automq.com/slack).
6+
7+
## Idea 1: AutoMQ Table Topic Solution Workshop
8+
9+
**Objective:**
10+
11+
To build hands-on, visually impressive industry solution templates (e.g., FinTech, Gaming, or IoT) that demonstrate AutoMQ's "Table Topic" capability—automatically transforming Kafka streams into Apache Iceberg tables.
12+
13+
**Description:**
14+
15+
How can AutoMQ Table Topic simplify real-time data architectures? In this project, you will create end-to-end "Showcase Demos." You'll use AI-driven development (Vibe Coding with Claude) to build data generators and pipelines, focusing on the final "Hands-on" experience and high-quality visualization. You are encouraged to explore any industry scenario you are passionate about.
16+
17+
**What you will do:**
18+
19+
- Design and implement 2-3 industry demo scenarios (e.g., Anti-fraud, IoT monitoring).
20+
- Use AI (Claude) to quickly generate data simulators and processing logic.
21+
- Create beautiful, interactive dashboards (using Grafana, Streamlit, or custom web apps) to visualize the data in Iceberg.
22+
- Produce a "Quick Start" guide for each solution to help users experience the flow in minutes.
23+
24+
**Skills Required:**
25+
26+
- Experience with AI-assisted coding (Prompt engineering).
27+
- Basic understanding of data streaming (Kafka/Iceberg).
28+
- Language-agnostic (Python, Java, Go, or Node.js are all welcome).
29+
30+
**Difficulty:** Medium
31+
32+
**Project Size:** 175 hours (Medium)
33+
34+
## Idea 2: Multi-Catalog Integration for AutoMQ Table Topic
35+
36+
**Objective:**
37+
38+
To make AutoMQ Table Topics instantly discoverable by connecting them to mainstream data catalogs like Apache Polaris or Unity Catalog.
39+
40+
**Description:**
41+
42+
AutoMQ transforms Kafka data into Iceberg tables automatically. This project focuses on integrating these tables with popular catalogs. Using AI/Vibe Coding (Claude), you will bridge the metadata gap, enabling a "Zero-ETL" experience where streaming data is immediately queryable by external SQL engines.
43+
44+
**What you will do:**
45+
46+
- Integrate AutoMQ with 2+ catalogs (e.g., Polaris, Unity, or DataHub) to sync metadata.
47+
- Use AI to accelerate API mapping and integration logic.
48+
- Demonstrate "Stream-to-SQL" by querying data via Trino or StarRocks.
49+
- Provide a simple docker-compose environment for the community.
50+
51+
**Skills Required:**
52+
53+
- AI-assisted coding, basic REST API knowledge, and curiosity about Data Lakes.
54+
55+
**Difficulty:** Medium
56+
57+
**Project Size:** 90~120 hours (Medium)
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributor Guidance for Google Summer of Code
2+
3+
## General Guidelines
4+
5+
1. **Read Official Guides:** Start by reading the [Contributor Guide](https://google.github.io/gsocguides/student/) written by the Google Summer of Code organizers.
6+
2. **Understand the Process:** Ensure you understand the GSoC timeline, application process, and the specific project you are applying for. We assume best intentions from all contributors throughout this period.
7+
3. **Join the Community:** Join our [Slack](https://go.automq.com/slack) and introduce yourself in the `#introduce` channel.
8+
4. **Start Early:** Begin drafting your proposal as early as possible using the template provided below. If you are new to AutoMQ, we highly recommend trying out our [Getting Started Guide](https://docs.automq.com/automq/getting-started) first.
9+
5. **Holistic Contribution:** We value all forms of contribution, including helping others on Slack, triaging GitHub issues, and reviewing pull requests. We prefer contributors who aim to support the community as a whole, not just the codebase.
10+
6. **Contributor Readiness:** Solving `good-first-issues` will show us that you can be a good GSoC contributor.
11+
7. **Mentor Interaction:** Reach out to and interact with mentors to discuss your solution and technical approach before submitting your final proposal.
12+
13+
## 1. Picking up and Working on Issues
14+
15+
- **Progressive Difficulty:** If you feel confident, you are welcome to help with other non-labeled issues, though we suggest starting with an easier task to familiarize yourself with our workflow.
16+
- **Assignment Policy:** To manage the influx of potential contributors and ensure timely resolutions, we will only assign issues to contributors who explicitly ask. If a PR is already open for an issue, please do not open a duplicate.
17+
- **The Value of Reviews:** We consider the quality of the reviews you leave on other contributors' PRs when evaluating your final proposal. Investigating an issue yourself—even if you don't solve it—helps you provide high-quality feedback. However, please refrain from "spammy" or low-effort reviews.
18+
- **Stuck? Reach Out:** If you find it difficult to claim an issue because others are faster, please message us on Slack. We will help find a suitable task for you.
19+
20+
## 2. Writing Your Proposal
21+
22+
Your proposal should demonstrate a clear understanding of how you plan to approach the project idea. Don't worry about building a perfect minute-by-minute schedule for the entire summer; we will refine the timeline together once the official mentoring period begins.
23+
24+
## Proposal Template
25+
26+
### [Project Title]
27+
28+
#### About Me
29+
30+
- Name, personal details, and contact information (Slack ID, Email).
31+
- Why are you the best person for this specific project?
32+
33+
#### Past Experience
34+
35+
Describe your coding experience. Refer to any internships, freelance work, professional roles, or open-source contributions (including personal projects).
36+
37+
#### Past Contributions
38+
39+
List your prior contributions to AutoMQ or other relevant open-source projects. Include links to Pull Requests, bug reports, or community support activities, organized in a neat table.
40+
41+
| Contribution Type | Link | Description |
42+
|-------------------|------|-------------|
43+
| PR | [#xxx](link) | Brief description |
44+
| Issue | [#xxx](link) | Brief description |
45+
46+
#### Project Proposal
47+
48+
- **Abstract:** A short description of your project (max 10 lines). Do not copy-paste the official project description; provide your own perspective. Define the problem, describe the current state, and propose your solution.
49+
- **Motivation:** What excites you about this project? What do you plan to achieve personally and professionally, and how will you measure success?
50+
- **Project Plan:** This should be the most extensive portion of your proposal. List clear deliverables, technical intricacies, architecture diagrams, and code snippets. It should clearly depict your deep understanding of the problem.
51+
52+
#### Additional Information
53+
54+
- Why are you excited about working on AutoMQ (e.g., cloud-native, streaming, Kafka)?
55+
- What is your availability during the GSoC period? Do you have other commitments like classes or internships?
56+
- How do you plan to stay connected with the AutoMQ community after GSoC ends?

0 commit comments

Comments
 (0)