- 
          
 - 
                Notifications
    
You must be signed in to change notification settings  - Fork 157
 
docs: initial start of the maintainership docs under the bounty program #1894
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
Changes from all commits
4277cb7
              874b8a0
              5b1500e
              41cd66b
              fc71618
              35eeafe
              d6a9752
              25d3020
              584bc2b
              f37bf03
              0ab924c
              40abea6
              b2bb91e
              b0778be
              c78342d
              366f69d
              ab5e7e4
              ac8ae1c
              01e3269
              f2d3c2c
              15cec29
              979e208
              a19449e
              f9585db
              d53ef4b
              5cda7ae
              d4f583e
              179f694
              9c7bb7c
              d9e7f5e
              83f2229
              b4ded4e
              3124d22
              216a9e0
              f12e505
              d5c2061
              8fd5aa2
              be08229
              d01e185
              bf16cf1
              6a3708f
              4ca4326
              b388be1
              8776c95
              784587a
              772a81e
              05199d1
              65d7f56
              0a5c907
              eb1fda5
              704a3bf
              0a60113
              cf4750c
              aae8288
              917ab54
              67adb1f
              42d5191
              48b16ae
              bfbe319
              ac6f7ee
              424a888
              5caa7a8
              dcbf502
              aebd134
              7e862cd
              29b6b68
              f4eafbd
              c0d80ab
              96b8568
              912c480
              9cab0ba
              4167079
              0cec8f6
              dead648
              e7605e2
              aed15ea
              0997bc0
              9b8c250
              75c45f3
              e86de9f
              52094bb
              87aa4c1
              d39fb3a
              ea76ff9
              77a5aa8
              File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| title: Maintainership Program Guide | ||
| weight: 5 | ||
| --- | 
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: AsyncAPI Maintainership Program Budgeting and Cost Breakdown | ||
| description: This overview page outlines the AsyncAPI Maintainership Program Budget and Cost Breakdown | ||
| weight: 190 | ||
| --- | ||
| 
     | 
||
| Piloting an in-house mentorship program, such as the AsyncAPI Maintainership Program, involves thoughtful financial planning. Thanks to generous donations through our [Open Collective](https://opencollective.com/asyncapi), the AsyncAPI Initiative has been able to allocate a fixed portion of its annual funds to support this program. | ||
| 
     | 
||
| To ensure long-term sustainability, transparency, and impact, we annually evaluate our budget to determine the number of projects we can support, which includes providing fair stipends for contributors, recognizing mentor efforts, and covering essential administrative costs. | ||
| 
     | 
||
| We’ve also created a dedicated [**Open Collective page**](https://opencollective.com/asyncapi/projects/asyncapi-mentorship) specifically for the Maintainership Program. This helps organizers easily manage and track program-specific expenses while keeping them loosely coupled from the broader Initiative’s finances. | ||
| 
     | 
||
| ## Budget Overview | ||
| 
     | 
||
| Each project accepted into the AsyncAPI Maintainership Program is funded with a **fixed $2,000 budget**, designed to fairly support both contributors and mentors. Whether a project is led by one contributor or a small team, the budget remains consistent to encourage scope discipline, collaboration, and resource sharing. | ||
| 
     | 
||
| ### Cost Breakdown (Per Project) | ||
| 
     | 
||
| | **Expense Item** | **Amount (USD)** | **Notes** | | ||
| | ------------------------------- | ---------------- | --------------------------------------------------------------------------- | | ||
| | Contributor Stipends | $1,500 | Split equally among all contributors on the project. | | ||
| | Mentor Recognition / Honorarium | $500 | Given to the lead mentor (or split between multiple mentors if applicable). | | ||
| | **Total Per Project** | **$2,000** | | | ||
| 
     | 
||
| > _If a project has two contributors, each will receive $750. If three, each receives $500, and so on. Mentor funds are fixed per project regardless of team size._ | ||
| 
     | 
||
| ### Annual Cohort Budget Projection | ||
| 
     | 
||
| The number of project slots we support each year depends entirely on our available funding. For example, with a **$16,000 annual budget**, we can support up to **8 projects**: | ||
| 
     | 
||
| | **Item** | **Per Project** | **Total (8 Projects)** | | ||
| | ----------------------- | --------------- | ---------------------- | | ||
| | Contributor Stipends | $1,500 | $12,000 | | ||
| | Mentor Honorariums | $500 | $4,000 | | ||
| | **Total Budget Needed** | — | **$16,000** | | ||
| 
     | 
||
| > _Note: Actual project slots may vary from year to year depending on the total funds raised and community needs._ | ||
| 
     | 
||
| This model allows us to scale based on financial support, ensuring every accepted project receives fair and consistent financial backing. | 
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: Code of Conduct | ||
| weight: 140 | ||
| --- | ||
| 
     | 
||
| The AsyncAPI Mentorship Program (AMP) is committed to fostering a respectful, inclusive, and harassment-free environment for everyone, regardless of gender identity, age, race, ethnicity, religion, disability, sexual orientation, technical experience, or background. | ||
| 
     | 
||
| By participating in AMP, whether as a contributor, mentor, or organizer, you agree to uphold this Code of Conduct across all program platforms, including GitHub, Slack, virtual meetings, and events. | ||
| 
     | 
||
| --- | ||
| 
     | 
||
| ## Expected Behavior | ||
| 
     | 
||
| To ensure a positive and productive experience for all, participants are expected to: | ||
| 
     | 
||
| - **Treat others with respect and kindness** | ||
| Engage with empathy. Assume good intentions and avoid personal attacks. | ||
| 
     | 
||
| - **Foster a supportive learning environment** | ||
| Be patient with contributors who are still learning. Provide constructive and actionable feedback. | ||
| 
     | 
||
| - **Communicate with clarity and care** | ||
| Use inclusive language. Avoid jargon or language that could be misunderstood. | ||
| 
     | 
||
| - **Honour your commitments** | ||
| Respect timelines, be responsive to communications, and inform others if you’re unable to meet expectations. | ||
| 
     | 
||
| - **Encourage collaboration over competition** | ||
| Recognize the shared goal of growth and impact. Celebrate each other’s progress. | ||
| 
     | 
||
| ## Unacceptable Behaviour | ||
| 
     | 
||
| The following actions are unacceptable in AMP spaces and may result in removal from the program: | ||
| 
     | 
||
| - Harassment, discrimination, or derogatory comments | ||
| - Demeaning, insulting, or aggressive language | ||
| - Inappropriate or offensive jokes, images, or memes | ||
| - Persistent interruptions or dismissiveness | ||
| - Retaliation against anyone who reports a concern | ||
| 
     | 
||
| ## Reporting a Violation | ||
| 
     | 
||
| If you experience or witness behaviour that violates this Code of Conduct, we encourage you to report it promptly. | ||
| 
     | 
||
| ### You can: | ||
| - **Message the AMP organizers directly via Slack** | ||
| - **Email the Program Organizers** ([email protected] | [email protected]) | ||
| 
         There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛠️ Refactor suggestion Convert email addresses to mailto links. - **Email the Program Organizers** ([[email protected]](mailto:[email protected]) | [[email protected]](mailto:[email protected]))🧰 Tools🪛 markdownlint-cli2 (0.17.2)47-47: Bare URL used (MD034, no-bare-urls) 47-47: Bare URL used (MD034, no-bare-urls) 🤖 Prompt for AI Agents | 
||
| - **Follow the [Incident Resolution Procedure](https://github.com/asyncapi/community/blob/master/code_of_conduct/coc-incident-resolution-procedures.md)** | ||
| 
     | 
||
| All reports will be handled with confidentiality, empathy, and care. Action will be taken based on the severity and context of the violation, ranging from warnings to removal from the program and community spaces. | ||
| 
     | 
||
| ## Final Note | ||
| 
     | 
||
| Our diversity makes us stronger. Our mentorship thrives when everyone feels safe, respected, and valued. Let’s build something meaningful together, collaboratively, inclusively, and respectfully. | ||
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: Communications | ||
| weight: 150 | ||
| --- | ||
| 
     | 
||
| # Communication Channels | ||
| 
     | 
||
| Effective communication is the foundation of a successful mentorship experience. To support smooth collaboration throughout the AsyncAPI Mentorship Program (AMP), we’ve established several dedicated communication channels for participants, mentors, and organizers. | ||
| 
     | 
||
| ## Slack (Primary Communication Hub) | ||
| 
     | 
||
| Slack is the main platform for real-time communication during the program. Once accepted, participants will be added (if not already) to the official AsyncAPI Slack workspace. | ||
| 
     | 
||
| Key channels include: | ||
| 
     | 
||
| - **#mentorships** – Program-wide updates, announcements, and shared resources. | ||
| - **#maintainership-[year]-cohort** – Dedicated support channel for contributors to ask questions and seek guidance. | ||
| - **#maintainership-[year]-mentors** – Mentor-only space for coordination, shared tips, and updates. | ||
| - **Direct Messages (DMs)** – For private, one-on-one conversations with mentors, mentees, or program organizers. | ||
| 
     | 
||
| _Please stay responsive to messages and maintain timely communication._ | ||
| 
     | 
||
| ## GitHub | ||
| 
     | 
||
| GitHub is the primary platform for managing and tracking project work. | ||
| 
     | 
||
| - **Repositories** – Each project will have a dedicated GitHub repository for code, issues, and pull requests. | ||
| - **GitHub Discussions** – Used by program organizers to share updates, request feedback, announce planning decisions, and collect project ideas. | ||
| 
     | 
||
| _Contributors must follow contribution guidelines and use clear, descriptive messages._ | ||
| 
     | 
||
| 
     | 
||
| All official communications from the AMP team — including evaluation reminders, key deadlines, and other important announcements — will be sent via email. | ||
| 
     | 
||
| _Be sure to check your inbox regularly and avoid missing critical updates from the program organizers._ | ||
| 
     | 
||
| ## Calendar Invites | ||
| 
     | 
||
| Major events such as kickoff calls and community meetings will be scheduled through our shared community calendar. | ||
| 
     | 
||
| 🔗 [View the AsyncAPI Calendar](https://calendar.google.com/calendar/u/0/[email protected]&ctz=UTC) | ||
| 
     | 
||
| ## Staying Updated | ||
| 
     | 
||
| To stay informed throughout the program: | ||
| 
     | 
||
| - Monitor the **#mentorships** channel on Slack for official notices. | ||
| - Regularly check your email for evaluation and event updates. | ||
| - Watch the GitHub Discussions board for announcements and opportunities to engage. | ||
| 
     | 
||
| _Tip: Turn on Slack and program's GitHub discussions notifications to ensure you never miss important updates._ | ||
| 
     | 
||
| If you’re ever unsure where to post a question or whom to ask, don’t hesitate to reach out to your mentor or a program organizer. | 
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: AsyncAPI Maintainership Program Community Values | ||
| description: This overview page outlines the AsyncAPI Maintainership Program Community Values | ||
| weight: 30 | ||
| --- | ||
| 
     | 
||
| At AsyncAPI, we believe that growing and sustaining open-source depends on empowering contributors, not just through code, but through connection, mentorship, and responsibility. The AsyncAPI Maintainership Program (AMP) is our structured pathway to help contributors develop the skills necessary to become skilled maintainers who can help steward AsyncAPI’s mission and projects. | ||
| 
     | 
||
| Rooted in values of inclusion, collaboration, and growth, this program ensures a safe, welcoming, and enriching environment for both mentees and mentors. By upholding the standards below, we aim to build an open-source culture that thrives for years to come. | ||
| 
     | 
||
| 
     | 
||
| ## AMP Sets a Standard of Excellence for Contributors | ||
| 
     | 
||
| - Maintains a **confirmed program schedule** with dates contributors can rely on. | ||
| 
         There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. mmmh we should also add a disclaimer here as not all dates can be meet  | 
||
| - Provides a dedicated **Slack channel and GitHub Discussion thread** for real-time questions and program updates. | ||
| - Ensures each project has **at least one lead mentor** responsible for guiding contributors and ensuring project success. | ||
| - Communicates any **program changes clearly and promptly**. | ||
| - Has **at least one lead organizer** always accessible to support contributors and address concerns. | ||
| 
     | 
||
| ## AMP Is Accessible and Flexible | ||
| 
     | 
||
| - Open to contributors from **all backgrounds, time zones, and experience levels**. | ||
| - Features a transparent and easy-to-follow **application process**. | ||
| - Completely **free to join**, with no entry barriers. | ||
| - Respects contributors' **personal commitments and schedules**. | ||
| - Promotes **low-pressure learning**, with flexible timelines and goals. | ||
| - Sets **clear expectations** at the start of each cohort to help participants stay focused. | ||
| 
     | 
||
| ## AMP Is Fair | ||
| 
         There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add that previous accepted mentees are not eligible  | 
||
| 
     | 
||
| - **Organizers do not participate** in any cohort as contributors. | ||
| - **Current AsyncAPI maintainers** are ineligible to participate as mentees. | ||
| - Contributors who are actively participating in **other programs (e.g., GSoC)** during the cohort are **not eligible**. | ||
| 
     | 
||
| # AMP Builds a Safe and Inclusive Culture | ||
| 
     | 
||
| - Adopts and upholds the **AsyncAPI Code of Conduct**. | ||
| - Holds both mentors and mentees **accountable for respectful, constructive interactions**. | ||
| - Provides **safe spaces** for discussing mental health, burnout, and personal development. | ||
| - Encourages **self-care and setting boundaries**. | ||
| - Celebrates **all forms of contribution** including code, documentation, design, community, and more. | ||
| - Enforces a zero-tolerance policy for **Code of Conduct violations or misconduct**. | ||
| 
     | 
||
| **Creating an empowering open-source environment where contributors of all experience levels can grow into maintainers is at the heart of the AsyncAPI Maintainership Program.** These principles reflect the experience we strive to create within the program, and the contributor culture we are building across the AsyncAPI ecosystem: one that is rooted in continuous learning, inclusivity, and long-term sustainability. | ||
| Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Application Review Process | ||
| weight: 70 | ||
| --- | ||
| 
     | 
||
| The AsyncAPI Maintainership Program features a two-step contributor application process: the **Initial Application Phase** and the **Final Selection Phase**. | ||
| 
     | 
||
| ## Initial Application Phase | ||
| 
     | 
||
| During this phase, contributor applications are reviewed collaboratively by program organizers and mentors to ensure alignment with project needs and contributor readiness. | ||
| 
     | 
||
| - **General Screening**: | ||
| Program organizers conduct an initial review to filter out applications that fall into the following categories: | ||
| - Applications that **do not follow** the required template | ||
| - Submissions that **rely heavily** or **vaguely** on **AI-generated** content | ||
| - Applicants with **no prior** open-source contribution history | ||
| - Proposals that are **misaligned** or **unrelated** to any project idea | ||
| 
     | 
||
| - **Mentor Review**: | ||
| Applications that pass the initial screening are forwarded to the appropriate mentors. Mentors assess each submission based on its alignment with the project’s scope, clarity, feasibility, and the applicant’s relevant experience. | ||
| 
     | 
||
| - **Shortlisting Candidates:** | ||
| Based on their evaluations, mentors can submit a shortlist of up to **three preferred contributors** per project to the program organizers for final consideration in the next phase (contribution period). | ||
| 
     | 
||
| ## Final Application Phase | ||
| 
     | 
||
| This phase serves as the final review stage, where mentors evaluate contributors who have advanced to the contribution period. The goal is to assess each contributor’s performance and suitability for the main program phase. | ||
| 
     | 
||
| - If a mentor has **multiple contributors**, this phase helps determine which applicant is best suited to continue in the program. | ||
| - If a mentor has **only one contributor**, this phase acts as a final checkpoint to decide whether the contributor meets the expectations to proceed. | ||
| 
     | 
||
| Mentors will assess the following criteria during the final application review: | ||
| 
     | 
||
| - **Communication:** | ||
| Contributors are evaluated on their responsiveness, clarity, and professionalism in communication throughout the contribution phase. | ||
| 
     | 
||
| - **Project Understanding:** | ||
| Mentors assess how well contributors understood the project’s goals and requirements, as demonstrated through their questions, discussions, and submitted work. | ||
| 
     | 
||
| - **Quality of Contributions:** | ||
| The relevance, completeness, and quality of contributions such as **PRs**, **documentation**, or **research** will be closely reviewed to evaluate the contributor’s technical capability. | ||
| 
     | 
||
| - **Collaboration & Conduct:** | ||
| Emphasis is placed on how well contributors interacted with mentors and the community, respecting collaboration norms and the Code of Conduct. | 
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,59 @@ | ||||||
| --- | ||||||
| title: Benefits & Expectations | ||||||
| weight: 80 | ||||||
| --- | ||||||
| 
     | 
||||||
| The AsyncAPI Maintainership Program (AMP) is more than just mentorship and a stipend, it’s a shared journey of learning, contribution, and community building. While AMP offers you world-class guidance and career-changing opportunities, it also relies on your dedication, collaboration, and accountability to succeed. | ||||||
| 
         There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 
        Suggested change
       
    
  | 
||||||
| 
     | 
||||||
| Think of it as a two-way street: here’s what you can expect from us, and what we expect from you. | ||||||
| 
     | 
||||||
| ## What You'll Gain | ||||||
| 
     | 
||||||
| ### Personalized Mentorship | ||||||
| 
     | 
||||||
| Learn directly from AsyncAPI’s core team, including Technical Steering Committee members, Ambassadors, and experienced maintainers, who are deeply committed to your growth and to fostering a thriving open-source ecosystem. | ||||||
| 
     | 
||||||
| ### Real-World Experience | ||||||
| 
     | 
||||||
| Work on production-grade, high-impact projects that are actively used by teams and companies. Your work will be merged, deployed, and making an impact, often during the program itself. | ||||||
| 
     | 
||||||
| ### Community Recognition | ||||||
| 
     | 
||||||
| Gain visibility and credibility within the AsyncAPI community and the broader open-source world. You might even be invited to speak at events, share your journey, and inspire others. | ||||||
| 
     | 
||||||
| ### Career-Boosting Visibility | ||||||
| AMP is a launchpad. Many alumni have gone on to secure internships, full-time roles, or speaking engagements thanks to the skills and recognition gained here. You’ll also receive public endorsements, mentorship reviews, and a certificate of completion to strengthen your portfolio. | ||||||
| 
     | 
||||||
| ## What You’ll Contribute | ||||||
| 
     | 
||||||
| ### Communication | ||||||
| 
     | 
||||||
| - **Be responsive**: Check in with your mentor regularly and communicate early if you’re stuck or unavailable. | ||||||
| 
     | 
||||||
| - **Attend meetings**: Join scheduled calls on time and respect your mentor’s time. | ||||||
| 
     | 
||||||
| - **Ask questions**: Curiosity shows engagement — there are no “dumb” questions. | ||||||
| 
     | 
||||||
| - **Give updates**: Share progress weekly or bi-weekly, even if it’s small. | ||||||
| 
     | 
||||||
| - **Be respectful**: Treat everyone with empathy, patience, and kindness. | ||||||
| 
     | 
||||||
| ### Collaboration | ||||||
| 
     | 
||||||
| - **Engage with the community**: Join discussions, participate in bonding activities, and be active on GitHub, Slack, and sync calls. | ||||||
| 
     | 
||||||
| - **Work in the open**: Publish your code under an OSI-approved open-source license. | ||||||
| 
     | 
||||||
| - **Follow standards**: Adhere to AsyncAPI coding, contribution, and documentation guidelines. | ||||||
| 
     | 
||||||
| - **Be open to feedback**: Use constructive criticism to improve. | ||||||
| 
     | 
||||||
| - **Support others**: Offer help and celebrate fellow contributors’ wins. | ||||||
| 
     | 
||||||
| ### Commitment | ||||||
| 
     | 
||||||
| - Dedicate at least 30 hours per week for 12 weeks to your project. | ||||||
| 
     | 
||||||
| - If life throws curveballs (illness, outages, emergencies), communicate early and adjust expectations with your mentor. | ||||||
| 
     | 
||||||
| - Plan around milestones, meet deadlines, and follow through on commitments. | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Remove redundant horizontal rule.
The standalone
---at line 10 renders a horizontal rule after the frontmatter; it’s unnecessary and may confuse readers.🤖 Prompt for AI Agents