Program Status: Completed

AsyncAPI Ideas Page: Google Summer of Code 2024

Welcome to the AsyncAPI Ideas Page with our proposed projects for Google Summer of Code (GSoC) 2024! If you are an interested student/contributor, please don't hesitate to contact our mentors directly to discuss project ideas.

Note: Projects with checkboxes are project that made it to the final.

1) Autofix for Spectral Linting Errors: VS Code Extension ✅

Enhance the AsyncAPI Preview + Spectral VS Code extension by introducing an autofix feature. This improvement aims to streamline the editing experience by automatically resolving common Spectral linting errors directly within the IDE.

• 🎯 Outcome: Automate corrections for standard spectral linting issues in AsyncAPI documents. Learn more.
• 🛠️ Skills Required: TypeScript/JavaScript and understanding of Spectral rules.
• 🧩 Difficulty: Easy/Medium
• 👩🏿‍🏫 Mentor(s): Pavel Bodiachevskii
• 👩🏿‍🏫 Mentee: Esther Xiao
• ⏳ Length: 175 Hours

2) Script Stability Enhancement for AsyncAPI Website ✅

Improve the AsyncAPI website's robustness by enhancing script stability in the /scripts/* directory. This project involves selecting a suitable testing framework for JavaScript and Next.js, integrating it with the website, developing detailed test cases for scripts, and setting up a GitHub Actions CI workflow for automated testing.

• 🎯 Outcome: Achieve a stable website framework to support continuous development and updates.
• 🛠️ Skills Required: JavaScript, Next.js, unit testing, and CI/CD practices.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Sambhav Gupta | Ansh Goyal
• 👩🏿‍🏫 Mentee: Vishvamsinh Vaghela
• ⏳ Length: 350 Hours

3) AsyncAPI Generator Maintainership ✅

This initiative aims to guide you on a journey from being a contributor to becoming a maintainer of the project. You'll gain insight into the responsibilities of a maintainer, involving tasks beyond mere coding.

• 🎯 Outcome: Taking responsibility for the project's future and continuous improvement.
• 🛠️ Skills Required: JavaScript/TypeScript, testing libraries, Docker, virtualization, and test automation.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Lukasz Gornicki
• 👩🏿‍🏫 Mentee: Mintu Gogoi | Yuan Yuan
• ⏳ Length: 350 Hours

4) Markdown and MermaidJS Diagrams Preview: VS Code Extension ✅

Upgrade the AsyncAPI Preview VS Code extension to include a feature for visualizing message payloads through Markdown and MermaidJS Class Diagrams. It also incorporates an export feature for the Markdown preview to facilitate its use in external documentation. This enhancement will work with both AsyncAPI schemas and Avro (.avsc) files to offer a dynamic and interactive view of message structures.

• 🎯 Outcome: Deliver an enriched AsyncAPI preview tool that provides a user-friendly, graphical representation of message payloads, improving comprehension and documentation within the AsyncAPI ecosystem.
• 🛠️ Skills Required: TypeScript/JavaScript, MermaidJS, and AsyncAPI schemas.
• 🧩 Difficulty: Easy/Medium
• 👩🏿‍🏫 Mentor(s): Iván García Sainz-Aja | Azeez Elegbede
• 👩🏿‍🏫 Mentee: Nikhil Chaudhari
• ⏳ Length: 175 Hours

5) AsyncAPI Website UI Kit Development ✅

Create a UI Kit for the AsyncAPI website to ensure brand visual consistency and streamline web development. The project will leverage Tailwind CSS, focusing on component-based class encapsulation to minimize class duplication and promote a modular, easy-to-maintain design system.

• 🎯 Outcome: Establish an AsyncAPI Website UI Kit that aligns with our design principles, facilitating the creation of uniform and manageable website elements.
• 🛠️ Skills Required: JavaScript, React, Storybook, and TailwindCSS.
• 🧩 Difficulty: Easy/Medium
• 👩🏿‍🏫 Mentor(s): Azeez Elegbede | Akshat Nema
• 👩🏿‍🏫 Mentee: Ashmit JaiSarita Gupta
• ⏳ Length: 350 Hours

6) Dynamic Open Graph Preview for AsyncAPI Studio ✅

Improve social sharing for AsyncAPI Studio by implementing a dynamic Open Graph link preview generator. This feature will create context-specific preview images for shared links, incorporating key details like the title, description, and statistics from the shared AsyncAPI document.

• 🎯 Outcome: Provide a richer, more informative link-sharing experience on platforms like Twitter, LinkedIn, Facebook, and Slack with custom preview images.
• 🛠️ Skills Required: TypeScript/JavaScript and React.
• 🧩 Difficulty: Easy/Medium
• 👩🏿‍🏫 Mentor(s): Sergio Moya
• 👩🏿‍🏫 Mentee: Ankit Dash
• ⏳ Length: 175 Hours

7) Conference Website Maintenance ✅

Ensure our conference website remains a dynamic and user-friendly for the upcoming 2024 AsyncAPI Conference.

• 🎯 Outcome: Improve the website's efficiency and user-friendliness for an improved user experience.
• 🛠️ Skills Required: JavaScript, Tailwind, and any testing framework.
• 🧩 Difficulty: Easy/Medium
• 👩🏿‍🏫 Mentor(s): Azeez Elegbede | Aishat Muibudeen | Thulisile Sibanda
• 👩🏿‍🏫 Mentee: Ashmit Jagtap
• ⏳ Length: 350 Hours

Contact AsyncAPI Mentors

• Join our Slack workspace. Observe our Slack etiquette and AsyncAPI code of conduct.
• Join the dedicated Mentorship channel #09_mentorships to meet all other GSoC mentees and mentors.

FAQ

1. How active are previous GSoC contributors in AsyncAPI? Although AsyncAPI hasn't directly participated in GSoC, our projects were featured in Postman's proposal last year. Active contributors from that cohort include:

   • @14Richa in our .github, community, and optimizer repositories.
   • @reachaadrika in our AsyncAPI website repository.
   • @oviecodes in our Glee and parser-js repositories.

2. Is using ChatGPT for GSoC project proposals allowed? We advise against using ChatGPT or similar AI tools for your GSoC project proposals with AsyncAPI. If you choose to use such tools, we require that you fully disclose this in your application.

3. Where is the AsyncAPI source code located? You can find all AsyncAPI source code on GitHub under our organization: https://github.com/asyncapi.

If you have further questions or queries, please create an issue in this /community repo (with the prefix GSoC 2024) or start an open AsyncAPI discussion.