Skip to content
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

[📑 Docs]: AsyncAPI Maintainership Program Docs #1766

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

[📑 Docs]: AsyncAPI Maintainership Program Docs #1766

thulieblack opened this issue Mar 5, 2025 · 3 comments

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants