VS Code Extension Maintainership

[AceTheCreator]

Overview

The VS Code AsyncAPI Preview extension is a valuable tool for developers working with AsyncAPI specifications in Visual Studio Code. However, it requires active maintainership to improve stability, enhance features, and ensure long-term sustainability. This project will guide contributors in becoming maintainers, handling code improvements, issue triaging, release management, and community engagement.

Why This is Needed

• Lack of Active Maintenance: The extension needs regular updates, issue resolution, and feature improvements.
• Improving Developer Experience: Users rely on the extension for real-time AsyncAPI visualization and validation, requiring better performance and new capabilities.
• Enhancing Spectral Linting & Auto-fixes: The extension should support custom validation rules and autofix suggestions for AsyncAPI files.

Project Goals

✅ Improve & Maintain the Extension:

• Review, refactor, and enhance the existing codebase.
• Improve performance, stability, and usability of the extension.

✅ Enhance Spectral Linting & Validation:

• Support custom Spectral rules for AsyncAPI validation.
• Implement autofix suggestions for common linting issues.

✅ Improve Logging & Debugging Capabilities:

• Enhance logging mechanisms for better debugging.
• Provide clear error messages and user feedback.

✅ Ensure Long-Term Sustainability:

• Actively triage and resolve GitHub issues.
• Improve documentation for contributors and users.
• Manage releases and automate deployment workflows.

Expected Outcome
By the end of GSoC 2025, the VS Code AsyncAPI Preview extension will have an active maintainer, improved performance, enhanced validation features, and a structured roadmap for future development.

Skills Required

TypeScript/JavaScript
VS Code Extensions Development
Spectral Linting
Testing & Debugging
Open Source Contribution

Difficulty Level

🟡 Medium/Hard

Resources

VS Code AsyncAPI Preview Extension
Spectral API Linting
VS Code Extension Development Docs
AsyncAPI Specification

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[Souvikns]

Hey, i can help with this, in my new work I am working on vscode extension, I am learning vscode extension building as well, I can help with this.

[AceTheCreator]

Hey, i can help with this, in my new work I am working on vscode extension, I am learning vscode extension building as well, I can help with this.

As a mentor?

[Karan-Palan]

Hey @AceTheCreator ,
I hope you’re doing well! I’m interested in contributing to the VS Code AsyncAPI Preview Extension Maintainership project for GSoC 2025, and I’d love to understand how I can get started.
I’ve previously built a VS Code extension for the JSON Schema community that integrates sourcemeta/blaze for validation and linting Github Repository. Given my experience, I want to align my contributions with the AsyncAPI extension to make a meaningful impact.
Could you guide me on:

• How I can start contributing to the extension?
• Any specific issues or areas that need attention?
• What skills or concepts I should focus on to be a great fit for this project?

I’m eager to contribute and learn more about the extension’s needs. Looking forward to your guidance!

Thanks,
Karan Palan

[Bishoywadea]

hello @AceTheCreator how are you doing?
I'm Bishoy Wadea, a third-year Computer Engineering student and a former Microsoft intern. I'm interested in contributing to your projects for GSoC 2025. To demonstrate my understanding of the codebase and my ability to contribute reliably, I have submitted a PR: #1353 which has been reviewed by contributors. They have provided positive feedback, and it is expected to be merged soon.
I am particularly interested in this idea
I would like to know the best way to get started or to demonstrate that I can handle these tasks. Would you recommend submitting a formal proposal, developing a prototype, or another approach?
Looking forward to your guidance.

[ivangsa]

Hi, as the main developer and current maintainer I would like to point out two important requirements to be a good candidate to be next maintainer:

• one, to be a user of the software. If you don't use it or know how it works, hardly you will be able to steer the software further and/or help current users..
• second, at a distance: know vscode extensions APIs. Every thing can be learnt, that's why I point out this comes second at a distance..

This may sound obvious, that's why I like to make sure it's well understood.

(I developed and maintained this extension because I needed it an used it, so I learnt vscode extensions apis myself..)

[Karan-Palan]

Alright @ivangsa
Also are there any issues that can help get familiar with codebase and also be a meaningful contribution?

[ivangsa]

What would you like to see even if you still don't know how to dev it?

[Karan-Palan]

Sure, I'll use it extensively first