Status: Completed

AsyncAPI Mentorship Program 2024

Welcome to the AsyncAPI Mentorship Program 2024 project ideas page! If you are an interested contributor, please don't hesitate to contact our mentors directly to discuss project ideas.

1) Enhancing Developer Experience in CLI ✅

Improve the AsyncAPI CLI by adding features like validating files with custom rules, syncing with remote systems, publishing to schema registries, rendering documentation, and fixing test case execution. Also, address remaining DX issues in the CLI.

• 🎯 Outcome: Enhanced CLI with validation, sync, publish, and documentation rendering capabilities.
• 🛠️ Skills Required: JavaScript/TypeScript, Node.js, CLI development, Testing.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Souvik De
• 👩🏿‍🏫 Mentee: Aayush Saini
• ⏳ Length: 350 Hours

2) Becoming a Maintainer of AsyncAPI Generator ✅

This initiative aims to guide you 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. Familiarize with the AsyncAPI Generator by setting it up locally, running tests, and improving the development guide.

• 🎯 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: Mohan Kumar
• ⏳ Length: 350 Hours

3) Migration of build + workflow scripts to TypeScript ✅

Migrate existing Node.js scripts to TypeScript for improved code uniformity, scalability, and maintainability. This involves setting up ts-node without altering the current Node.js setup, converting build and workflow scripts to TypeScript, ensuring compatibility with GitHub workflows, and maintaining or expanding test coverage.

• 🎯 Outcome: All build and workflow scripts migrated to TypeScript with maintained test coverage.
• 🛠️ Skills Required: TypeScript, Node.js, GitHub Actions, Testing.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Akshat Nema
• 👩🏿‍🏫 Mentee: Zeel Rajodiya
• ⏳ Length: 350 Hours

4) Holopin Design Project ✅

Design visually appealing digital badges for AsyncAPI, ensuring they're visually appealing and fit within our branding. This project aims to create user-friendly digital badges for our community, ensuring alignment with AsyncAPI's branding and easy recognizability.

• 🎯 Outcome: A complete set of branded digital badges that recognize member contributions.
• 🛠️ Skills Required: Figma (or similar design tools), graphic design, branding principles.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Aishat Muibudeen
• 👩🏿‍🏫 Mentee: Olumide
• ⏳ Length: 175 Hours

5) Onboarding Contributor Guides ✅

Enhance the onboarding process by developing clear, structured, and automated guides, ensuring new contributors can efficiently integrate into the project. This will include written guides and media resources like YouTube videos to simplify the journey for each role.

• 🎯 Outcome: Comprehensive onboarding documentation with written guides and video tutorials.
• 🛠️ Skills Required: Technical writing, documentation, video creation, contributor experience.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Thulisile Sibanda | Anthony Campolo
• 👩🏿‍🏫 Mentee: Anushka Saxena | Aahil | Ezinne Anne Emilia
• ⏳ Length: 350 Hours

6) Path to Maintainership for the AsyncAPI React Project ✅

The AsyncAPI React component is essential for rendering and validating API documentation based on the AsyncAPI specification, with over 5 million downloads. This project aims to revitalize its development by onboarding a new maintainer to work on bug fixes, UX improvements, feature additions, issue triaging, and engaging contributors.

• 🎯 Outcome: Active maintainer ensuring long-term stability and continuous improvement of AsyncAPI React.
• 🛠️ Skills Required: TypeScript, React, open-source contribution, component development.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Azeez Elegbede
• 👩🏿‍🏫 Mentee: Mohammed Mehdi
• ⏳ Length: 350 Hours

7) Integrating EDAVisualiser Application Focus View into VS Code AsyncAPI Plugin ✅

Enhance the VS Code AsyncAPI Plugin by adding EDAVisualiser's application focus view. This new feature will allow users to visualize how an application interacts with other defined applications. The project involves integrating the EDAVisualiser library, implementing a configuration system for related AsyncAPI documents, and creating a user interface to switch between preview modes.

• 🎯 Outcome: Enhanced VS Code extension with application interaction visualization capabilities.
• 🛠️ Skills Required: JavaScript/TypeScript, VS Code extension development, AsyncAPI knowledge.
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Iván García Sainz-Aja
• 👩🏿‍🏫 Mentee: Milan D Vijay
• ⏳ Length: 350 Hours

8) Expand AsyncAPI Community Docs ✅

This project focuses on enhancing the AsyncAPI community documentation by automating the onboarding process and documenting workflows for contributors, maintainers, ambassadors, and governance. The goal is to streamline contributions, encourage participation, and provide clear guidelines for various roles.

• 🎯 Outcome: Comprehensive community documentation covering contribution flows, Git workflows, and maintainership guidelines.
• 🛠️ Skills Required: Technical writing, documentation, community management, workflow design.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Thulisile Sibanda | Anthony Campolo
• 👩🏿‍🏫 Mentee: Anushka Saxena | Aahil | Ezinne Anne Emilia
• ⏳ Length: 350 Hours

9) AI-Powered AsyncAPI Generator

Create an AI-based extension for the AsyncAPI Generator that automatically generates initial AsyncAPI specifications from natural language descriptions or existing API documentation. Leveraging NLP models, this tool can take user-provided requirements and convert them into accurate AsyncAPI specs.

• 🎯 Outcome: AI-powered tool that generates AsyncAPI specifications from natural language.
• 🛠️ Skills Required: JavaScript/TypeScript, Machine Learning, NLP, AsyncAPI Generator.
• 🧩 Difficulty: Hard
• 👩🏿‍🏫 Mentor(s): Azeez Elegbede
• ⏳ Length: 350 Hours

10) Performance + Accessibility Improvement of Website

With the addition of multiple components, pages and MD files, it's now important to make the website efficient for all web + mobile users. Currently, the performance of the website has critically low numbers in both web and mobile view. This project focuses on improving performance metrics and adding necessary accessibility labels.

• 🎯 Outcome: Significantly improved website performance and accessibility scores.
• 🛠️ Skills Required: Next.js, React, Performance optimization, Web accessibility (WCAG).
• 🧩 Difficulty: Medium/Hard
• 👩🏿‍🏫 Mentor(s): Sambhav Gupta
• ⏳ Length: 350 Hours

11) User Research + Usability Testing on the AsyncAPI Website

Perform usability tests across AsyncAPI tools periodically to gather data that could lead to more grounded ideas for design improvements. Create a new page on the website explaining the process of being a participant in a user research study and steps to get involved.

• 🎯 Outcome: User research framework and dedicated webpage for research participation.
• 🛠️ Skills Required: UX research, usability testing, user interviews, data analysis.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Aishat Muibudeen
• ⏳ Length: 175 Hours

12) Implementation and Integration of New Layout for Studio

Transform Studio from a simple playground into a fully-featured suite to help developers work with event-driven architectures (EDA) and APIs. It will become a tool you can use to easily design your services and share them with your colleagues.

• 🎯 Outcome: Redesigned Studio interface with enhanced features for EDA development.
• 🛠️ Skills Required: React, TypeScript, UI/UX design, AsyncAPI.
• 🧩 Difficulty: Hard
• 👩🏿‍🏫 Mentor(s): Ashish Padhy | Fran Méndez
• ⏳ Length: 350 Hours

13) Technical Blog Posts on Integrating AsyncAPI with Kafka

Integrating AsyncAPI with Kafka offers a structured approach to managing and documenting Kafka topics, streamlining communication between teams, and enhancing development efficiency. This proposal outlines a series of technical blog posts focused on AsyncAPI's capabilities, Kafka's integration potential, and best practices.

• 🎯 Outcome: Series of high-quality technical blog posts on AsyncAPI-Kafka integration.
• 🛠️ Skills Required: Technical writing, AsyncAPI, Apache Kafka, event-driven architecture.
• 🧩 Difficulty: Medium
• 👩🏿‍🏫 Mentor(s): Leonardo Torres
• ⏳ Length: 175 Hours

Timeline

• Project proposal applications open: August 30th - October 2nd
• Mentees applications open: October 10th - October 24th
• Application review by the mentors/admission decisions: October 24th - November 4th

Mentorship duration - 12 to 18weeks (full-time schedule)

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 mentees and mentors.

FAQ

1. How active are previous mentees in AsyncAPI? Many mentees from our 2023 programs remain actively involved in the community, with several transitioning to maintainer roles. You can view detailed retention statistics on our Mentorship Programs Insights page.

2. What is the time commitment for mentees? Projects range from 175 to 350 hours depending on scope and complexity. This typically translates to 10-20 hours per week over 3-6 months.

3. Can I apply for multiple projects? Yes, but we recommend focusing on one project that aligns best with your skills and interests to ensure quality contributions.

4. 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 Mentorship 2024) or start an open AsyncAPI discussion.