|
| 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