community icon indicating copy to clipboard operation
community copied to clipboard

[📑 Docs]: AsyncAPI Maintainership Program Docs

Open thulieblack opened this issue 9 months ago • 10 comments

What Dev Docs changes are you proposing?

We need to create a dedicated documentation section for the Maintainership Program. The documentation will explain how we operate the program and provide guidelines for mentors and mentees, along with the rules. Since this is our in-house mentorship, we will implement slightly different (and stricter) rules compared to GSoC. Our goal is to align with community objectives in growing maintainers through the Maintainership program.

What Needs to Be Done

Create a folder titled Maintainership Program in the community repository that contains all the necessary documentation.

Key documents will include:

  1. What is the AsyncAPI Maintainership Program?
    • A definition that explains the program, why it exists, and who it is intended for.
  2. Mentor's Guide
    • Guidelines for mentors, including how to mentor effectively, expectations, communicating with mentees, and best practices.
  3. Mentee's Guide
    • Requirements for mentees, instructions for submitting proposals, steps for getting started, and guidelines for participation.
  4. Evaluation, Stipends & Payments
    • Information on evaluation, stipend distribution, eligibility criteria, and requirements.
  5. Project Application & Selection Process
    • A step-by-step guide for both mentees and mentors on how to apply, including the application selection criteria.
  6. Program Timeline
    • Important dates, milestones, and deadlines related to the program.
  7. Communication Channels
    • Information on where discussions will take place (Slack, GitHub, forums, etc.) and how participants can stay updated.
  8. Project Submission and Selection Guidelines
    • Instructions on how projects should be structured, best practices to follow, and contribution expectations.
  9. Code of Conduct
    • Guidelines to ensure a respectful and inclusive environment for all participants.
  10. FAQs
    • Responses to common questions to facilitate a smoother onboarding experience.
  11. Any Other Essential Information
    • Any additional details necessary for ensuring smooth participation.

Why This Matters

Having a clear and well-documented Maintainership section will help mentors and mentees navigate the program more effectively, set expectations, and easily access important information without confusion.

Resources

We can get inspiration from these projects https://docs.linuxfoundation.org/lfx/mentorship https://www.outreachy.org/mentor/mentor-faq/

We can adjust the rest of the mentorship docs once we have everything set for the Maintainership.

Code of Conduct

  • [x] I agree to follow this project's Code of Conduct

thulieblack avatar Mar 05 '25 08:03 thulieblack

Is anything missing here? @derberg @Shurtu-gal @AceTheCreator

thulieblack avatar Mar 05 '25 08:03 thulieblack

LGTM! 👍🏾

AceTheCreator avatar Mar 05 '25 09:03 AceTheCreator

LGTM

Shurtu-gal avatar Mar 06 '25 07:03 Shurtu-gal

Hi, is this issue available to work on? Should I go ahead and start working on it and submit a PR for review, or should I wait for it to be assigned to me? Please let me know and assign it to me if possible. thanks @thulieblack

shradiphylleia avatar Mar 10 '25 15:03 shradiphylleia

This issue isn't available or contribution @shradiphylleia

thulieblack avatar Mar 11 '25 07:03 thulieblack

Hey @thulieblack, is this bounty issue open for pickup, or is it something you're planning to take on yourself?

If yes, I would like to pick it up.

Mayaleeeee avatar Mar 14 '25 06:03 Mayaleeeee

Bounty Issue's service comment

Text labels: bounty/2025-Q2, bounty/medium, bounty/docs, bounty/misperformed, bounty/eol First assignment to regular contributors: 2025-03-21 00:00:00 UTC+12:00 End Of Life after: 2025-04-30 23:59:59 UTC-12:00

@asyncapi/bounty_team

The Bounty Program is not a Mentorship Program. The accepted level of Bounty Program Participants is Middle/Senior.
Regular contributors should explain in meaningful words how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

aeworxet avatar Mar 17 '25 13:03 aeworxet

Hi @asyncapi/bounty_team,

I’d love to take on this issue and create a well-structured Maintainership Program documentation. My approach will include:

  • Organizing a dedicated folder in the community repo.
  • Drafting clear guidelines for mentors, mentees, evaluations, application process, timeline, and communication.
  • Aligning documentation with AsyncAPI’s goals, ensuring clarity and accessibility.
  • Taking inspiration from Linux Foundation Mentorship & Outreachy to structure effectively.
  • Iterating based on feedback to refine and improve the content.

With my experience in open-source contributions and technical documentation, I’m confident in delivering high-quality docs. Please assign me this issue—I’m excited to contribute! 🚀

Thanks! Payal Kumari

PayalKumari10 avatar Mar 18 '25 08:03 PayalKumari10

Assigning the issue to @AceTheCreator because he's the program lead and maintainer, which falls under priority 1

thulieblack avatar Mar 24 '25 07:03 thulieblack

Bounty Issue's Timeline

Complexity Level Assignment Date (by GitHub) Start Date (by BP Rules) End Date (by BP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
Medium 2025-03-24 2025-04-07 2025-05-18 2025-04-20 2025-05-04 2025-05-18
Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.
Keep in mind the responsibility for violations of the Timeline.

Assignee: @AceTheCreator (githubID: 40604284)

aeworxet avatar Mar 24 '25 08:03 aeworxet

@AceTheCreator how is this going any update?

thulieblack avatar Apr 11 '25 07:04 thulieblack

@thulieblack

Bounty Program Participants have the right not to be touched until Draft PR Submission date, which is 2025-04-20, in the case of this Bounty Issue.

aeworxet avatar Apr 11 '25 09:04 aeworxet

Aaah got it, I'm a week earlier 😁

Image

thulieblack avatar Apr 11 '25 09:04 thulieblack

@AceTheCreator (githubID: 40604284), please provide the Draft PR of the Bounty Issue.

aeworxet avatar Apr 21 '25 12:04 aeworxet

@AceTheCreator (githubID: 40604284), please provide the Draft PR of the Bounty Issue.

aeworxet avatar Apr 29 '25 13:04 aeworxet

Hey @aeworxet, apologies for the delay in getting back to you. I haven’t completed the first draft yet, but I’ll make sure to submit it by Thursday noon.

AceTheCreator avatar May 06 '25 08:05 AceTheCreator

@aeworxet here's a draft pr on the ongoing effort to document the AsyncAPI Maintainership Program

AceTheCreator avatar May 06 '25 19:05 AceTheCreator

@AceTheCreator (githubID: 40604284), please provide an update to the PR of the Bounty Issue.

aeworxet avatar May 13 '25 06:05 aeworxet

@AceTheCreator (githubID: 40604284), please provide changes to the PR of the Bounty Issue that will allow it to be merged.

aeworxet avatar May 15 '25 06:05 aeworxet

@aeworxet @asyncapi/bounty_team I’d appreciate it if I could get an extension on this bounty issue until Thursday, so I can implement the necessary changes to get the PR ready for merging.

AceTheCreator avatar May 19 '25 06:05 AceTheCreator

Upon request of the Bounty Program Participant (@AceTheCreator (githubID: 40604284)), all remaining target dates of the Bounty Issue's Timeline are extended by one calendar week.

Bounty Issue's Timeline Extended

Complexity Level Assignment Date (by GitHub) Start Date (by BP Rules) End Date (by BP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
Medium 2025-03-24 2025-04-07 2025-05-25 2025-04-20 2025-05-04 2025-05-25
Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.
Keep in mind the responsibility for violations of the Timeline.

Assignee: @AceTheCreator (githubID: 40604284)

aeworxet avatar May 19 '25 09:05 aeworxet

@AceTheCreator (githubID: 40604284), please provide changes to the PR of the Bounty Issue that will allow it to be merged.

aeworxet avatar May 22 '25 12:05 aeworxet

This Bounty Issue is in its final stages.

@thulieblack (githubID: 66913810), please review the PR for the Bounty Issue.

aeworxet avatar May 26 '25 00:05 aeworxet

First review done!

thulieblack avatar May 27 '25 15:05 thulieblack

AsyncAPI Maintainer (@thulieblack (githubID: 66913810)) delayed a response critical for the technical resolution of the Bounty Issue on GitHub for one period of three consecutive working days https://github.com/asyncapi/community/pull/1894#event-17774047552 https://github.com/asyncapi/community/issues/1766#issuecomment-2912934655 so all remaining target dates of the Bounty Issue's Timeline are extended by one calendar week.

Bounty Issue's Timeline Extended

Complexity Level Assignment Date (by GitHub) Start Date (by BP Rules) End Date (by BP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
Medium 2025-03-24 2025-04-07 2025-06-01 2025-04-20 2025-05-04 2025-06-01
Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.
Keep in mind the responsibility for violations of the Timeline.

Assignee: @AceTheCreator (githubID: 40604284)

aeworxet avatar May 28 '25 00:05 aeworxet

@AceTheCreator (githubID: 40604284), please provide changes to the PR of the Bounty Issue that will allow it to be merged.

aeworxet avatar May 30 '25 04:05 aeworxet

Bounty Issue has been misperformed 🙁

aeworxet avatar Jun 02 '25 12:06 aeworxet

Bounty Issue's service comment

According to the Bounty Program Rules

https://github.com/asyncapi/community/blob/master/BOUNTY_PROGRAM.md?plain=1#L128-L130 https://github.com/asyncapi/community/blob/master/BOUNTY_PROGRAM.md?plain=1#L231 https://github.com/asyncapi/community/blob/master/BOUNTY_PROGRAM.md?plain=1#L237

@AceTheCreator (githubID: 40604284) has received the First Suspension for misperforming on one of two Bounty Issues, chosen for simultaneous resolution for the first time.

With the utmost respect for the contributions made, but also having the best interests of the Bounty Program in mind, @AceTheCreator (githubID: 40604284) will be prohibited from participating in the Bounty Program from 2025-07-01 00:00:00 UTC+12:00 to 2025-08-31 23:59:59 UTC-12:00 (inclusive).

AsyncAPI hopes that this pause will provide an opportunity for reflection and perhaps a chance to address any challenges that may have led to this situation.

The reward for this Bounty Issue will not be paid to @AceTheCreator (githubID: 40604284) even in the case of its voluntary completion.

Probation period after the First Suspension's expiration will be from 2025-10-01 00:00:00 UTC+12:00 to 2026-02-28 23:59:59 UTC-12:00 (inclusive).

aeworxet avatar Jun 02 '25 12:06 aeworxet

@aeworxet i don't think i should be suspended for this 😄

AceTheCreator avatar Jun 02 '25 12:06 AceTheCreator

Hi @aeworxet 🙂,

I’d like to respectfully challenge the decision regarding the suspension of this bounty.

From my perspective, the work required for this bounty far exceeded the expectations of a medium-level task. It involved a considerable amount of planning, coordination, and implementation, more aligned with the scope of an advanced bounty.

While the pull request hasn’t been merged yet, that’s primarily because I’m still gathering some final pieces of information particularly FAQs and insights from the ongoing cohort—which are crucial to delivering a comprehensive and useful resource. All previously requested changes have already been made locally, along with several additional improvements that enhance the overall quality and usability of the work.

I genuinely believe the suspension decision doesn’t fully reflect the time, effort, and level of complexity that went into completing this bounty. I’m happy to provide more context or share the updated local version if that helps with reevaluation.

Looking forward to your thoughts and open to further discussion on this.

Thanks again for your time and support! 🙏

AceTheCreator avatar Jun 02 '25 12:06 AceTheCreator