|
1 | 1 | --- |
2 | | -title: GSoC |
| 2 | +title: Contributor's Guide |
3 | 3 | nav_order: 9 |
4 | | -has_children: true |
5 | | -has_toc: false |
| 4 | +has_children: true |
6 | 5 | layout: default |
7 | | -nav_exclude: true |
8 | | -permalink: "/gsoc" |
| 6 | +permalink: "/contribute" |
9 | 7 | lang: en |
10 | 8 | --- |
11 | 9 |
|
12 | 10 |
|
13 | | -# 🚀 Google Summer of Code (GSoC) with BIRDS Open Source |
| 11 | +# 📖 Contributor's Guide |
14 | 12 |
|
15 | | -## 🌍 Contributors: Get Paid to Work on Open Source Projects! |
16 | | -Are you a student passionate about **space technology and open source software**? Join us for GSoC and work on real-world **CubeSat development projects** while getting **paid to learn and contribute**! |
| 13 | +Found a typo? Have ideas for improvement? Learn how to contribute to the BIRDS Open Source ecosystem. |
17 | 14 |
|
18 | | -## 👩🏫 Mentors: Help Shape the Next Generation of Space Developers! |
19 | | -If you're an experienced developer, researcher, or engineer, become a **mentor** to guide students, grow the open-source ecosystem, and bring fresh ideas into BIRDS Open Source! |
20 | 15 |
|
21 | | ---- |
| 16 | +We have a project list already and [you can find it here]({{site.url}}/project-list). |
22 | 17 |
|
23 | | -## 📌 What is BIRDS Open Source & GSoC? |
24 | | -BIRDS Open Source is a **collaborative CubeSat development community** that emerged from the **Kyutech BIRDS program**. Our mission is to make **satellite technology more accessible** by sharing software, hardware designs, and documentation openly. |
| 18 | +--- |
25 | 19 |
|
26 | | -**Google Summer of Code (GSoC)** is a global program that allows **students** to contribute to open-source projects while earning a stipend. This is a great opportunity to: |
27 | | -✅ **Gain real-world experience** in space systems development |
28 | | -✅ **Collaborate with experts** and open-source enthusiasts |
29 | | -✅ **Improve your technical and problem-solving skills** |
30 | | -✅ **Make a lasting impact** in the space industry |
| 20 | +## ✍️ **How to Propose Projects to contribute to** |
31 | 21 |
|
32 | | -👉 Learn more about GSoC: [Google Summer of Code](https://summerofcode.withgoogle.com) |
| 22 | +### **Things to consider** |
33 | 23 |
|
34 | | ---- |
35 | 24 |
|
36 | | -## 🚀 How to Get Started |
37 | | -🔹 **Explore Project Ideas** – Check out our [GSoC 2025 Project Ideas List]({{site.url}}/gsoc-ideas-2025) |
38 | | -🔹 **Join the Community** – Engage with mentors and past contributors in our forums and chat groups |
39 | | -🔹 **Set Up Your Dev Environment** – Clone our repositories and try building our software |
40 | | -🔹 **Start Contributing** – Submit a small pull request to familiarize yourself with our workflow |
| 25 | +### 1️⃣ **Synopsis** |
| 26 | +- **What is your project about?** (1-2 sentences) |
| 27 | +- **Why is it important?** |
| 28 | +- **What problem does it solve?** |
41 | 29 |
|
42 | | -> **💡 Pro Tip:** The best way to stand out is by actively contributing **before applications open!** |
| 30 | +### 2️⃣**Benefits to the Community** |
| 31 | +- How will this project **help BIRDS Open Source**? |
| 32 | +- How will it **benefit the open-source space community**? |
| 33 | +- How will the final output be **used after GSoC**? |
43 | 34 |
|
44 | | ---- |
| 35 | +### 3️⃣ **Deliverables & Milestones** |
| 36 | +- **List the key goals and features** you aim to complete |
| 37 | +- **Break your timeline into 3 phases**: |
| 38 | + - **Community Bonding Period**: Research, setup, first contributions |
| 39 | + - **Phase 1**: Develop core functionality, initial testing |
| 40 | + - **Phase 2**: Expand features, refine implementation |
| 41 | + - **Final Phase**: Complete, test, and document |
45 | 42 |
|
46 | | -## 📝 How to Apply |
47 | | -📅 **GSoC 2025 Applications Open: March [TBA], 2025** |
| 43 | +### 4️⃣ **Technical Details** |
| 44 | +- **What technologies will you use?** (Languages, frameworks, tools) |
| 45 | +- **How will you implement your solution?** |
| 46 | +- **Any potential challenges, and how will you overcome them?** |
48 | 47 |
|
49 | | -1️⃣ **Choose a project** from our [GSoC Project Ideas List]({{site.url}}/gsoc-ideas-2025) |
50 | | -2️⃣ **Talk to Mentors** – Ask questions and get feedback on your proposal |
51 | | -3️⃣ **Draft Your Proposal** – Explain your project plan, timeline, and motivation |
52 | | -4️⃣ **Submit Your Application** on the GSoC portal |
| 48 | +### 5️⃣ **Previous Experience** |
| 49 | +- **Have you contributed to open source before?** (Not mandatory but helpful) |
| 50 | +- **Relevant projects you've worked on** (GitHub links if possible) |
| 51 | +- **Why are you interested in BIRDS Open Source & space projects?** |
53 | 52 |
|
54 | | -🔗 Check out our **[Application Guide]({{site.url}}/gsoc-application-guide)** for tips on writing a strong proposal! |
| 53 | +### 6️⃣ **Commitment & Availability** |
| 54 | +- How many hours per week can you dedicate? |
| 55 | +- Do you have any **other commitments** during GSoC? |
55 | 56 |
|
56 | 57 | --- |
57 | 58 |
|
58 | | -## [📩 Get in Touch!](mailto:{{site.email}}) |
59 | | -Have questions? We're happy to help! |
| 59 | +## 📅 **Next Steps** |
| 60 | +📌 **Join Our Community** – Ask mentors for feedback on your draft |
| 61 | +📌 **Submit Early** – Avoid last-minute issues! |
| 62 | +📌 **Follow Up** – Stay engaged and show your enthusiasm |
| 63 | + |
| 64 | +📨 **Need Help? [Contact Us!]({{site.telegram}})** |
| 65 | +📌 **GitHub Discussions:** [BIRDS Open Source](https://github.com/orgs/BIRDSOpenSource/discussions) |
| 66 | +📌 **Email:** {{site.email}} |
| 67 | + |
| 68 | +🚀 **We look forward to your application! Good luck!** |
0 commit comments