Skip to content

[📑 Docs]: AsyncAPI Maintainership Program Docs #1766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 task done
thulieblack opened this issue Mar 5, 2025 · 13 comments
Open
1 task done

[📑 Docs]: AsyncAPI Maintainership Program Docs #1766

thulieblack opened this issue Mar 5, 2025 · 13 comments
Assignees

Comments

@thulieblack
Copy link
Member

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

  • I agree to follow this project's Code of Conduct
@thulieblack
Copy link
Member Author

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

@AceTheCreator
Copy link
Member

LGTM! 👍🏾

@Shurtu-gal
Copy link
Contributor

LGTM

@shradiphylleia
Copy link

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

@thulieblack
Copy link
Member Author

This issue isn't available or contribution @shradiphylleia

@Mayaleeeee
Copy link
Member

Mayaleeeee commented Mar 14, 2025

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.

@aeworxet
Copy link
Contributor

Bounty Issue's service comment

Text labels: bounty/2025-Q2, bounty/medium, bounty/docs
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.

@PayalKumari10
Copy link

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

@thulieblack
Copy link
Member Author

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

@aeworxet
Copy link
Contributor

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 aeworxet moved this to In Progress in Bounty Program Mar 24, 2025
@thulieblack
Copy link
Member Author

@AceTheCreator how is this going any update?

@aeworxet
Copy link
Contributor

@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.

@thulieblack
Copy link
Member Author

Aaah got it, I'm a week earlier 😁

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests

8 participants