generator icon indicating copy to clipboard operation
generator copied to clipboard

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

Open derberg opened this issue 3 months ago • 21 comments

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 [email protected]

derberg avatar Mar 19 '24 15:03 derberg