From 80084ae48b35df3f9fc943df20bdacd7104cf28a Mon Sep 17 00:00:00 2001 From: Aahil13 Date: Fri, 10 Jan 2025 16:41:24 +0100 Subject: [PATCH 1/9] docs: Add onboarding maintainers guide --- .../Onboarding-maintainer-guide.md | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs/onboarding-guide/Onboarding-maintainer-guide.md diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md new file mode 100644 index 000000000..cf70788bb --- /dev/null +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -0,0 +1,69 @@ +# Onboarding Guide for AsyncAPI Maintainers + +Welcome to the AsyncAPI Maintainer Onboarding Guide! + +This guide is designed to provide you with everything you need to begin your journey as a maintainer within the AsyncAPI ecosystem. Whether you’re managing workflows, mentoring new contributors, or ensuring that the project stays on track, your role is essential to the success of the community. + +Maintainers are the backbone of any open-source project. You help ensure that processes run smoothly, contributors are supported, and the project evolves sustainably. This guide will help you navigate your responsibilities, from managing code contributions to creating workflows and fostering a healthy, productive community. + +Before we go into getting you started, let's try and clarify just *who* a maintainer is. + +## Who is an AsyncAPI Maintainer? + +A maintainer is an individual who plays a crucial role in overseeing and guiding the development and growth of an open-source project. As a maintainer for AsyncAPI, you will manage pull requests, resolve issues, enforce coding standards, and ensure the community thrives by helping contributors. + +As a maintainer, you'll be responsible for: + +- Overseeing the technical direction of the project +- Managing workflows and GitHub Actions to automate tasks +- Identifying and appointing new maintainers +- Mentoring new contributors and helping them navigate their journey +- Recognizing and rewarding contributions to foster community engagement + +Basically, you're the *glue* that holds the project together and ensures that everything runs smoothly. + +## Steps to becoming a Maintainer + +Before you can become a **maintainer**, you need to start as a **contributor**. The journey from contributor to maintainer is a rewarding one, and it involves the following steps: + +### 1. **Pick an Issue** + + - **Join existing PR reviews**: If you're not sure where to start, begin by reviewing open [pull requests](https://github.com/asyncapi/community/pulls). This will give you an understanding of the code and where your contributions might fit in. + + - **Look for "*good first issue*" labels**: These [issues](https://github.com/asyncapi/community/issues) are beginner-friendly and will help you get familiar with the project’s structure. Additionally, you can check out the [#97_bot-github-new-issues-prs](https://asyncapi.slack.com/archives/C01J06RL10X) channel on Slack for new issues and PRs. + + - **Participate in live streams**: AsyncAPI maintainers sometimes host [live streams](https://www.asyncapi.com/community/events) where they walk through parts of the project. You can request a session on the specific area you want to contribute to. + + > **NOTE**: Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged. + +### 2. **Open a Pull Request** + +For a comprehensive guide on how to open a pull request, refer to the [AsyncAPI Git Workflow Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md). + + - **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes. + + - **Make changes**: Implement the changes required to resolve the issue you picked. Ensure your code adheres to the project’s coding standards. + + - **Submit a Pull Request**: Once you’re done, submit a pull request to the main repository. Make sure to include a detailed description of your changes. + + - **Participate in discussions**: Engage with maintainers and other contributors in the PR comments section. This will help you understand the project better and improve your contributions. + +### 3. **Get your Pull Request Merged** + + - After submitting a pull request, it’s time for the maintainers to review it. + + - If you notice no one reviewing your PR (which is rare) or if you need a review urgently, don’t hesitate to ping the maintainers on Slack or GitHub + + - Make sure all the checks (tests, style checks, etc.) turn green for a smooth merge. + +### 4. **Receive an invitation to become a Maintainer 🎉** + + - **Recognition**: After contributing consistently, the maintainers will invite you to join the team. This invitation is a recognition of your contributions and dedication. + + - If you feel you've made enough contributions, but haven't received an invitation, you can open an issue in the relevant repository to discuss your contributions with the maintainers. You can see an example of such an issue [here](https://github.com/asyncapi/cli/issues/1616). + +## Some Useful Links + +- [AsyncAPI Contributor’s Guide](https://github.com/asyncapi/cli/blob/master/CONTRIBUTING.md): Learn how to set up, contribute, and work on pull requests. +- [GitHub Workflow Setup Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md): A detailed walkthrough of setting up GitHub Actions and managing workflows. +- [AsyncAPI Slack Community](https://www.asyncapi.com/slack-invite): Join the community and interact with fellow contributors and maintainers. From f2fbe4128f63bfbef2d834f69916d8a8c6ebcb5b Mon Sep 17 00:00:00 2001 From: Aahil13 Date: Tue, 14 Jan 2025 18:09:32 +0100 Subject: [PATCH 2/9] docs: updated review changes --- .../Onboarding-maintainer-guide.md | 44 ++++++++----------- 1 file changed, 18 insertions(+), 26 deletions(-) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index cf70788bb..c6925e548 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -2,25 +2,23 @@ Welcome to the AsyncAPI Maintainer Onboarding Guide! -This guide is designed to provide you with everything you need to begin your journey as a maintainer within the AsyncAPI ecosystem. Whether you’re managing workflows, mentoring new contributors, or ensuring that the project stays on track, your role is essential to the success of the community. - -Maintainers are the backbone of any open-source project. You help ensure that processes run smoothly, contributors are supported, and the project evolves sustainably. This guide will help you navigate your responsibilities, from managing code contributions to creating workflows and fostering a healthy, productive community. +This document provides you with guidelines about everything you need to know to begin your journey as a maintainer within the AsyncAPI ecosystem. Maintainers are the backbone of any open-source project, helping with different activities that help the project to stay on track and foster a healthy, productive community. Before we go into getting you started, let's try and clarify just *who* a maintainer is. ## Who is an AsyncAPI Maintainer? -A maintainer is an individual who plays a crucial role in overseeing and guiding the development and growth of an open-source project. As a maintainer for AsyncAPI, you will manage pull requests, resolve issues, enforce coding standards, and ensure the community thrives by helping contributors. - -As a maintainer, you'll be responsible for: +A maintainer is an individual who plays a crucial role in overseeing and guiding the development and growth of an open-source project. As a maintainer for AsyncAPI, you'll be responsible for: - Overseeing the technical direction of the project +- Helping with reviewing and resolving issues and pull requests - Managing workflows and GitHub Actions to automate tasks +- Enforcing coding standards - Identifying and appointing new maintainers - Mentoring new contributors and helping them navigate their journey - Recognizing and rewarding contributions to foster community engagement -Basically, you're the *glue* that holds the project together and ensures that everything runs smoothly. +Essentially, you serve as a person that *binds* the project together and guarantees that everything runs smoothly. ## Steps to becoming a Maintainer @@ -28,42 +26,36 @@ Before you can become a **maintainer**, you need to start as a **contributor**. ### 1. **Pick an Issue** - - **Join existing PR reviews**: If you're not sure where to start, begin by reviewing open [pull requests](https://github.com/asyncapi/community/pulls). This will give you an understanding of the code and where your contributions might fit in. +- **Join existing PR reviews**: If you're not sure where to start, begin by reviewing open [pull requests](https://github.com/asyncapi/community/pulls). This will give you an understanding of the code and where your contributions might fit in. - - **Look for "*good first issue*" labels**: These [issues](https://github.com/asyncapi/community/issues) are beginner-friendly and will help you get familiar with the project’s structure. Additionally, you can check out the [#97_bot-github-new-issues-prs](https://asyncapi.slack.com/archives/C01J06RL10X) channel on Slack for new issues and PRs. +- **Look for "*good first issue*" labels**: These [issues](https://github.com/asyncapi/community/issues) are beginner-friendly and will help you get familiar with the project’s structure. Additionally, you can check out the [#97_bot-github-new-issues-prs](https://asyncapi.slack.com/archives/C01J06RL10X) channel on Slack for new issues and PRs. - - **Participate in live streams**: AsyncAPI maintainers sometimes host [live streams](https://www.asyncapi.com/community/events) where they walk through parts of the project. You can request a session on the specific area you want to contribute to. +- **Participate in live streams**: AsyncAPI maintainers sometimes host [live streams](https://www.asyncapi.com/community/events) where they walk through parts of the project. You can request a session on the specific area you want to contribute to. - > **NOTE**: Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged. +> **NOTE**: Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged. ### 2. **Open a Pull Request** For a comprehensive guide on how to open a pull request, refer to the [AsyncAPI Git Workflow Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md). - - **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes. +- **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes. - - **Make changes**: Implement the changes required to resolve the issue you picked. Ensure your code adheres to the project’s coding standards. +- **Make changes**: Implement the changes required to resolve the issue you picked. Ensure your code adheres to the project’s coding standards. - - **Submit a Pull Request**: Once you’re done, submit a pull request to the main repository. Make sure to include a detailed description of your changes. +- **Submit a Pull Request**: Once you’re done, submit a pull request to the main repository. Make sure to include a detailed description of your changes. - - **Participate in discussions**: Engage with maintainers and other contributors in the PR comments section. This will help you understand the project better and improve your contributions. + - **Participate in discussions**: Engage with maintainers and other contributors in the PR comments section. This will help you understand the project better and improve your contributions. ### 3. **Get your Pull Request Merged** - - After submitting a pull request, it’s time for the maintainers to review it. +- After submitting a pull request, it’s time for the maintainers to review it. - - If you notice no one reviewing your PR (which is rare) or if you need a review urgently, don’t hesitate to ping the maintainers on Slack or GitHub +- If you notice no one reviewing your PR (which is rare) or if you need a review urgently, don’t hesitate to ping the maintainers on Slack or GitHub - - Make sure all the checks (tests, style checks, etc.) turn green for a smooth merge. +- Make sure all the checks (tests, style checks, etc.) turn green for a smooth merge. ### 4. **Receive an invitation to become a Maintainer 🎉** - - **Recognition**: After contributing consistently, the maintainers will invite you to join the team. This invitation is a recognition of your contributions and dedication. - - - If you feel you've made enough contributions, but haven't received an invitation, you can open an issue in the relevant repository to discuss your contributions with the maintainers. You can see an example of such an issue [here](https://github.com/asyncapi/cli/issues/1616). - -## Some Useful Links +- **Recognition**: After contributing consistently, the maintainers will invite you to join the team. This invitation is a recognition of your contributions and dedication. -- [AsyncAPI Contributor’s Guide](https://github.com/asyncapi/cli/blob/master/CONTRIBUTING.md): Learn how to set up, contribute, and work on pull requests. -- [GitHub Workflow Setup Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md): A detailed walkthrough of setting up GitHub Actions and managing workflows. -- [AsyncAPI Slack Community](https://www.asyncapi.com/slack-invite): Join the community and interact with fellow contributors and maintainers. +- If you haven't received an invitation despite contributing consistently, you can open an issue in the corresponding repository to discuss your contributions with the maintainers. You can see an example of such an issue [here](https://github.com/asyncapi/cli/issues/1616). \ No newline at end of file From f7023e8ba8d051160a7f25c474a62223cb9c56a1 Mon Sep 17 00:00:00 2001 From: Aahil13 Date: Tue, 14 Jan 2025 18:11:48 +0100 Subject: [PATCH 3/9] docs: updated review changes --- docs/onboarding-guide/Onboarding-maintainer-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index c6925e548..f9df2f082 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -44,7 +44,7 @@ For a comprehensive guide on how to open a pull request, refer to the [AsyncAPI - **Submit a Pull Request**: Once you’re done, submit a pull request to the main repository. Make sure to include a detailed description of your changes. - - **Participate in discussions**: Engage with maintainers and other contributors in the PR comments section. This will help you understand the project better and improve your contributions. +- **Participate in discussions**: Engage with maintainers and other contributors in the PR comments section. This will help you understand the project better and improve your contributions. ### 3. **Get your Pull Request Merged** From e4a358650fb826d79d4fdc181806ee8a4ef075bb Mon Sep 17 00:00:00 2001 From: Aahil13 Date: Thu, 16 Jan 2025 02:22:04 +0100 Subject: [PATCH 4/9] docs: updated review changes --- .../Onboarding-maintainer-guide.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index f9df2f082..43d45e29a 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -18,7 +18,7 @@ A maintainer is an individual who plays a crucial role in overseeing and guiding - Mentoring new contributors and helping them navigate their journey - Recognizing and rewarding contributions to foster community engagement -Essentially, you serve as a person that *binds* the project together and guarantees that everything runs smoothly. +Essentially, you serve as a person that binds the project together and guarantees that everything runs smoothly. ## Steps to becoming a Maintainer @@ -26,33 +26,34 @@ Before you can become a **maintainer**, you need to start as a **contributor**. ### 1. **Pick an Issue** -- **Join existing PR reviews**: If you're not sure where to start, begin by reviewing open [pull requests](https://github.com/asyncapi/community/pulls). This will give you an understanding of the code and where your contributions might fit in. +- **Join existing PR reviews**: If you're not sure where to start, begin by reviewing open [pull requests](https://github.com/pulls?q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+archived%3Afalse+) within the organization. This will give you a high-level understanding of the projects and where your contributions might fit in. -- **Look for "*good first issue*" labels**: These [issues](https://github.com/asyncapi/community/issues) are beginner-friendly and will help you get familiar with the project’s structure. Additionally, you can check out the [#97_bot-github-new-issues-prs](https://asyncapi.slack.com/archives/C01J06RL10X) channel on Slack for new issues and PRs. +- **Look for "*good first issue*" labels**: These [issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22) are beginner-friendly and will help you get familiar with the project’s structure. Additionally, you can check out the [#97_bot-github-new-issues-prs](https://asyncapi.slack.com/archives/C01J06RL10X) channel on Slack for new issues and PRs. - **Participate in live streams**: AsyncAPI maintainers sometimes host [live streams](https://www.asyncapi.com/community/events) where they walk through parts of the project. You can request a session on the specific area you want to contribute to. -> **NOTE**: Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged. +> [!NOTE] +> Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged. ### 2. **Open a Pull Request** -For a comprehensive guide on how to open a pull request, refer to the [AsyncAPI Git Workflow Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md). +For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md). - **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes. - **Make changes**: Implement the changes required to resolve the issue you picked. Ensure your code adheres to the project’s coding standards. -- **Submit a Pull Request**: Once you’re done, submit a pull request to the main repository. Make sure to include a detailed description of your changes. +- **Submit a Pull Request**: Once you’re done with the changes, submit a pull request to the main repository. Make sure to include a detailed description of your changes. - **Participate in discussions**: Engage with maintainers and other contributors in the PR comments section. This will help you understand the project better and improve your contributions. ### 3. **Get your Pull Request Merged** -- After submitting a pull request, it’s time for the maintainers to review it. +- **Pull Request Review Process**: After submitting a pull request, maintainers need to review it. -- If you notice no one reviewing your PR (which is rare) or if you need a review urgently, don’t hesitate to ping the maintainers on Slack or GitHub +- **Contact Maintainers**: If a pull request is not being reviewed (which is rare) or needs urgent review, contact maintainers on Slack or GitHub. -- Make sure all the checks (tests, style checks, etc.) turn green for a smooth merge. +- **Ensure Smooth Merge**: Ensure all checks (tests, style checks, etc.) pass before merging your PR. ### 4. **Receive an invitation to become a Maintainer 🎉** From 49a16e1d27b9b5c6a90f9b516f96bcce2e0a5ba4 Mon Sep 17 00:00:00 2001 From: Aahil13 Date: Sat, 18 Jan 2025 09:15:59 +0100 Subject: [PATCH 5/9] docs: fix inconsistent formatting --- .../Onboarding-maintainer-guide.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index 43d45e29a..d707ce18c 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -11,7 +11,7 @@ Before we go into getting you started, let's try and clarify just *who* a mainta A maintainer is an individual who plays a crucial role in overseeing and guiding the development and growth of an open-source project. As a maintainer for AsyncAPI, you'll be responsible for: - Overseeing the technical direction of the project -- Helping with reviewing and resolving issues and pull requests +- Helping with reviewing and resolving issues and pull requests (PR) - Managing workflows and GitHub Actions to automate tasks - Enforcing coding standards - Identifying and appointing new maintainers @@ -26,7 +26,7 @@ Before you can become a **maintainer**, you need to start as a **contributor**. ### 1. **Pick an Issue** -- **Join existing PR reviews**: If you're not sure where to start, begin by reviewing open [pull requests](https://github.com/pulls?q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+archived%3Afalse+) within the organization. This will give you a high-level understanding of the projects and where your contributions might fit in. +- **Join existing PR reviews**: If you're not sure where to start, begin by reviewing open [PR](https://github.com/pulls?q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+archived%3Afalse+) within the organization. This will give you a high-level understanding of the projects and where your contributions might fit in. - **Look for "*good first issue*" labels**: These [issues](https://github.com/issues?page=1&q=is%3Aopen+org%3Aasyncapi+sort%3Aupdated-desc+label%3A%22good+first+issue%22) are beginner-friendly and will help you get familiar with the project’s structure. Additionally, you can check out the [#97_bot-github-new-issues-prs](https://asyncapi.slack.com/archives/C01J06RL10X) channel on Slack for new issues and PRs. @@ -35,7 +35,7 @@ Before you can become a **maintainer**, you need to start as a **contributor**. > [!NOTE] > Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged. -### 2. **Open a Pull Request** +### 2. **Open a PR** For a comprehensive guide on how to create a fork and start contributing, refer to the [AsyncAPI Git Workflow Guide](https://github.com/asyncapi/community/blob/master/git-workflow.md). @@ -43,17 +43,17 @@ For a comprehensive guide on how to create a fork and start contributing, refer - **Make changes**: Implement the changes required to resolve the issue you picked. Ensure your code adheres to the project’s coding standards. -- **Submit a Pull Request**: Once you’re done with the changes, submit a pull request to the main repository. Make sure to include a detailed description of your changes. +- **Submit a PR**: Once you’re done with the changes, submit a PR to the main repository. Make sure to include a detailed description of your changes. - **Participate in discussions**: Engage with maintainers and other contributors in the PR comments section. This will help you understand the project better and improve your contributions. -### 3. **Get your Pull Request Merged** +### 3. **Get your PR merged** -- **Pull Request Review Process**: After submitting a pull request, maintainers need to review it. +- **PR review process**: After submitting a PR, maintainers need to review it. -- **Contact Maintainers**: If a pull request is not being reviewed (which is rare) or needs urgent review, contact maintainers on Slack or GitHub. +- **Contact maintainers**: If a PR is not being reviewed (which is rare) or needs urgent review, contact maintainers on Slack or GitHub. -- **Ensure Smooth Merge**: Ensure all checks (tests, style checks, etc.) pass before merging your PR. +- **Ensure smooth merge**: Ensure all checks (tests, style checks, etc.) pass before merging your PR. ### 4. **Receive an invitation to become a Maintainer 🎉** From 334faea236e9fbe42c2d0019f35e744f40d731e4 Mon Sep 17 00:00:00 2001 From: Aahil13 Date: Wed, 29 Jan 2025 01:06:36 +0100 Subject: [PATCH 6/9] docs: add more maintainer roles --- docs/onboarding-guide/Onboarding-maintainer-guide.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index d707ce18c..11fa3868b 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -2,7 +2,7 @@ Welcome to the AsyncAPI Maintainer Onboarding Guide! -This document provides you with guidelines about everything you need to know to begin your journey as a maintainer within the AsyncAPI ecosystem. Maintainers are the backbone of any open-source project, helping with different activities that help the project to stay on track and foster a healthy, productive community. +This document provides you with guidelines about everything you need to know to begin your journey as a maintainer within the AsyncAPI ecosystem. Maintainers are the backbone of any open-source project, helping with different activities that help the project stay on track and foster a healthy, productive community. Before we go into getting you started, let's try and clarify just *who* a maintainer is. @@ -18,6 +18,10 @@ A maintainer is an individual who plays a crucial role in overseeing and guiding - Mentoring new contributors and helping them navigate their journey - Recognizing and rewarding contributions to foster community engagement +But being a maintainer goes beyond these responsibilities—it’s about **ownership** and **leadership**. You’re not just merging code; you’re shaping the project’s future. This means stepping up to unblock contributors stuck on a PR, advocating for improvements in the roadmap, or leading releases to ensure smooth deployments. You’ll proactively identify risks, mediate discussions to align decisions with AsyncAPI’s vision, and celebrate wins to keep the community motivated. + +Maintainers also **lead by example**. You’ll mentor others not just by answering questions, but by teaching contributors *why* coding standards matter or *how* to structure a feature. You’ll balance technical rigor with empathy, ensuring decisions serve both the project’s goals and its people. + Essentially, you serve as a person that binds the project together and guarantees that everything runs smoothly. ## Steps to becoming a Maintainer @@ -33,7 +37,7 @@ Before you can become a **maintainer**, you need to start as a **contributor**. - **Participate in live streams**: AsyncAPI maintainers sometimes host [live streams](https://www.asyncapi.com/community/events) where they walk through parts of the project. You can request a session on the specific area you want to contribute to. > [!NOTE] -> Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged. +> Make sure whatever issue you pick isn't marked "Do-not-merge," or else your PR won't be merged. ### 2. **Open a PR** @@ -57,6 +61,6 @@ For a comprehensive guide on how to create a fork and start contributing, refer ### 4. **Receive an invitation to become a Maintainer 🎉** -- **Recognition**: After contributing consistently, the maintainers will invite you to join the team. This invitation is a recognition of your contributions and dedication. +- **Recognition**: After contributing consistently and demonstrating leadership — whether through code, reviews, mentorship, or strategic input — the maintainers will invite you to join the team. This invitation is a recognition of your ownership and dedication to AsyncAPI’s success. - If you haven't received an invitation despite contributing consistently, you can open an issue in the corresponding repository to discuss your contributions with the maintainers. You can see an example of such an issue [here](https://github.com/asyncapi/cli/issues/1616). \ No newline at end of file From 252c9987dfdd6c37926421c1bc76fa84831979c2 Mon Sep 17 00:00:00 2001 From: Prince Onyeanuna Date: Thu, 6 Feb 2025 09:11:49 +0100 Subject: [PATCH 7/9] Update docs/onboarding-guide/Onboarding-maintainer-guide.md Co-authored-by: Rohit <108233235+TRohit20@users.noreply.github.com> --- docs/onboarding-guide/Onboarding-maintainer-guide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index 11fa3868b..310aef463 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -14,6 +14,7 @@ A maintainer is an individual who plays a crucial role in overseeing and guiding - Helping with reviewing and resolving issues and pull requests (PR) - Managing workflows and GitHub Actions to automate tasks - Enforcing coding standards +- Enforcing relevant and up-to-date documentation - Identifying and appointing new maintainers - Mentoring new contributors and helping them navigate their journey - Recognizing and rewarding contributions to foster community engagement From 76b863beb1ccb8f33999fc9735325d831620acff Mon Sep 17 00:00:00 2001 From: Prince Onyeanuna Date: Thu, 6 Feb 2025 09:12:36 +0100 Subject: [PATCH 8/9] Update docs/onboarding-guide/Onboarding-maintainer-guide.md Co-authored-by: Rohit <108233235+TRohit20@users.noreply.github.com> --- docs/onboarding-guide/Onboarding-maintainer-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index 310aef463..73169be4b 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -2,7 +2,7 @@ Welcome to the AsyncAPI Maintainer Onboarding Guide! -This document provides you with guidelines about everything you need to know to begin your journey as a maintainer within the AsyncAPI ecosystem. Maintainers are the backbone of any open-source project, helping with different activities that help the project stay on track and foster a healthy, productive community. +This document aims to provide comprehensive guidelines about everything you need to know to begin your journey as a maintainer within the AsyncAPI ecosystem. Maintainers are the backbone of any open-source project, helping with different activities that help the project stay on track and foster a healthy, productive community. Before we go into getting you started, let's try and clarify just *who* a maintainer is. From bcb5c4979202818f4f49af2d02f298e4b4e699e2 Mon Sep 17 00:00:00 2001 From: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com> Date: Wed, 26 Feb 2025 14:25:26 +0200 Subject: [PATCH 9/9] minor update --- docs/onboarding-guide/Onboarding-maintainer-guide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/onboarding-guide/Onboarding-maintainer-guide.md b/docs/onboarding-guide/Onboarding-maintainer-guide.md index 73169be4b..dc498c514 100644 --- a/docs/onboarding-guide/Onboarding-maintainer-guide.md +++ b/docs/onboarding-guide/Onboarding-maintainer-guide.md @@ -21,9 +21,9 @@ A maintainer is an individual who plays a crucial role in overseeing and guiding But being a maintainer goes beyond these responsibilities—it’s about **ownership** and **leadership**. You’re not just merging code; you’re shaping the project’s future. This means stepping up to unblock contributors stuck on a PR, advocating for improvements in the roadmap, or leading releases to ensure smooth deployments. You’ll proactively identify risks, mediate discussions to align decisions with AsyncAPI’s vision, and celebrate wins to keep the community motivated. -Maintainers also **lead by example**. You’ll mentor others not just by answering questions, but by teaching contributors *why* coding standards matter or *how* to structure a feature. You’ll balance technical rigor with empathy, ensuring decisions serve both the project’s goals and its people. +Maintainers also **lead by example**. You’ll mentor others not just by answering questions but by teaching contributors *why* coding standards matter or *how* to structure a feature. You’ll balance technical rigor with empathy, ensuring decisions serve both the project’s goals and its people. -Essentially, you serve as a person that binds the project together and guarantees that everything runs smoothly. +Essentially, you serve as a person who binds the project together and guarantees that everything runs smoothly. ## Steps to becoming a Maintainer @@ -64,4 +64,4 @@ For a comprehensive guide on how to create a fork and start contributing, refer - **Recognition**: After contributing consistently and demonstrating leadership — whether through code, reviews, mentorship, or strategic input — the maintainers will invite you to join the team. This invitation is a recognition of your ownership and dedication to AsyncAPI’s success. -- If you haven't received an invitation despite contributing consistently, you can open an issue in the corresponding repository to discuss your contributions with the maintainers. You can see an example of such an issue [here](https://github.com/asyncapi/cli/issues/1616). \ No newline at end of file +- If you haven't received an invitation despite contributing consistently, you can open an issue in the corresponding repository to discuss your contributions with the maintainers. You can see an example of such an issue [here](https://github.com/asyncapi/cli/issues/1616).