Proposal for mentorship of potential maintainers of generator -> `Becoming a Maintainer of AsyncAPI Generator`

derberg commented 6 months ago

What is this

This is a mentorship offer published as part of Google Summer of Code.

As maintainer of this project I offer mentor support for 2 mentees maximum.

btw, if you are interested to become maintainer just outside GSoC. Like you work for some company that invests in Generator and you wanna share maintenance load - feel free to reach out.

Idea

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.

Being a maintainer entails:

Defining potential enhancements as GitHub issues
Actively triaging incoming requests and bug fixes
Resolving bugs or providing guidance to others
Shifting focus from creating code to reviewing it at the pull request level
Occasionally writing documentation
And improvement refactors, writing tests? Still very important
And yes, sometimes coding new features

It's about taking responsibility for the project's future and continuous improvement. It's less about the brilliance of the code you produce.

All of the activities described above will be part of the mentorship journey.

Why it is interesting project?

Is this project beneficial for your future? Well, for landing a job, you'll naturally face technical interviews, but that's the easy part, and open-source contributions aren't necessary for that. There are numerous platforms available to learn fancy algorithms and such. To secure a job, you need experience. Completing a single project or contributing code for one feature isn't substantial experience. However, becoming a maintainer—now, that's something you can proudly showcase in an interview.

I can't guarantee that completing this mentorship will immediately qualify you to become a project maintainer. Your performance, attitude, and motivation will determine that. However, I can promise to support you throughout the journey and provide honest feedback on your strengths and areas needing improvement. Even if you're not yet ready to become a maintainer, I'll outline a plan for your next steps towards achieving that goal.

Requirements

Interested? Your proposal should demonstrate:

Familiarity with the project: https://github.com/asyncapi/generator and its documentation: https://www.asyncapi.com/docs/tools/generator - you figure out how to do it
Completion of this tutorial: https://www.asyncapi.com/docs/tools/generator/generator-template and providing a link to the repository where you've stored the code
Notes on any topics poorly explained in the documentation, issues encountered, and constructive criticism on aspects you disliked (content, navigation, order)—be thorough in your critique
Knowledge of JavaScript—I won't conduct interviews; just provide links to projects you've worked on
You get additional points for previous contributions to AsyncAPI—please provide links.
Put it in Google Docs and share with lpgornicki@gmail.com

lmgyuan commented 6 months ago

Hi @derberg! This is a wonderful project for me! I have done a full-stack project in javascript using React.js and Node.js, so I believe I have the required skills and knowledge. For the proposal tho, should we talk about summer project timeline and details so I can submit a thorough and great proposal through the GSoC application system? Or would the shared Google Docs suffice? Thanks in advance and I look forward to hearing from you!

lmgyuan commented 6 months ago

Also, although I have written an introduction in a different issue, if needed I could write one here again! Just let me know!

lmgyuan commented 6 months ago

I encountered these errors when I was testing the client:

(python-mqtt-client-template) yuanyuan@Yuans-MacBook-Pro-2 project % python test.py Exception ignored in: <function Client.del at 0x10404a480> Traceback (most recent call last): File "/Users/yuanyuan/anaconda3/envs/python-mqtt-client-template/lib/python3.11/site-packages/paho/mqtt/client.py", line 874, in del self._reset_sockets() File "/Users/yuanyuan/anaconda3/envs/python-mqtt-client-template/lib/python3.11/site-packages/paho/mqtt/client.py", line 1133, in _reset_sockets self._sock_close() File "/Users/yuanyuan/anaconda3/envs/python-mqtt-client-template/lib/python3.11/site-packages/paho/mqtt/client.py", line 1119, in _sock_close if not self._sock: ^^^^^^^^^^ AttributeError: 'Client' object has no attribute '_sock' Traceback (most recent call last): File "/Users/yuanyuan/workspace/python-mqtt-client-template/test/project/test.py", line 5, in client = TemperatureServiceClient() ^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/Users/yuanyuan/workspace/python-mqtt-client-template/test/project/client.py", line 9, in init self.client = mqtt.Client() ^^^^^^^^^^^^^ TypeError: Client.init() missing 1 required positional argument: 'callback_api_version'

May I ask what the 'callback_api_version' might be? I don't find it in the tutorial...

derberg commented 6 months ago

@lmgyuan

hey there, nice to see ya here

For the proposal tho, should we talk about summer project timeline and details so I can submit a thorough and great proposal through the GSoC application system? Or would the shared Google Docs suffice? Thanks in advance and I look forward to hearing from you!

I'm not sure on GSoC "logistics", better consult with people that run GSoC here at AsyncAPI, there will be some knowledge sharing sessions and I bet they can answer your question, just mentorship channel in our slack

May I ask what the 'callback_api_version' might be? I don't find it in the tutorial..

yeah, good question, I think in my tutorial I did not tackle topic of requirements.txt and did not specify Paho version and afaik they released some new versions - and maybe this is causing errors. I think Paho reached 2.0.0 but for tutorial I used 1.6.1 - please try to use this version and lemme know if that helps