Skip to content

Commit f2fbe41

Browse files
committed
docs: updated review changes
1 parent 25e57e2 commit f2fbe41

File tree

1 file changed

+18
-26
lines changed

1 file changed

+18
-26
lines changed

docs/onboarding-guide/Onboarding-maintainer-guide.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,68 +2,60 @@
22

33
Welcome to the AsyncAPI Maintainer Onboarding Guide!
44

5-
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.
6-
7-
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.
5+
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.
86

97
Before we go into getting you started, let's try and clarify just *who* a maintainer is.
108

119
## Who is an AsyncAPI Maintainer?
1210

13-
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.
14-
15-
As a maintainer, you'll be responsible for:
11+
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:
1612

1713
- Overseeing the technical direction of the project
14+
- Helping with reviewing and resolving issues and pull requests
1815
- Managing workflows and GitHub Actions to automate tasks
16+
- Enforcing coding standards
1917
- Identifying and appointing new maintainers
2018
- Mentoring new contributors and helping them navigate their journey
2119
- Recognizing and rewarding contributions to foster community engagement
2220

23-
Basically, you're the *glue* that holds the project together and ensures that everything runs smoothly.
21+
Essentially, you serve as a person that *binds* the project together and guarantees that everything runs smoothly.
2422

2523
## Steps to becoming a Maintainer
2624

2725
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:
2826

2927
### 1. **Pick an Issue**
3028

31-
- **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.
29+
- **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.
3230

33-
- **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.
31+
- **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.
3432

35-
- **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.
33+
- **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.
3634

37-
> **NOTE**: Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged.
35+
> **NOTE**: Make sure whatever issue you pick isn't marked "Do-not-merge" else your PR won't be merged.
3836
3937
### 2. **Open a Pull Request**
4038

4139
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).
4240

43-
- **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes.
41+
- **Fork the repository**: Fork the repository you want to contribute to and create a new branch for your changes.
4442

45-
- **Make changes**: Implement the changes required to resolve the issue you picked. Ensure your code adheres to the project’s coding standards.
43+
- **Make changes**: Implement the changes required to resolve the issue you picked. Ensure your code adheres to the project’s coding standards.
4644

47-
- **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.
45+
- **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.
4846

49-
- **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.
47+
- **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.
5048

5149
### 3. **Get your Pull Request Merged**
5250

53-
- After submitting a pull request, it’s time for the maintainers to review it.
51+
- After submitting a pull request, it’s time for the maintainers to review it.
5452

55-
- 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
53+
- 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
5654

57-
- Make sure all the checks (tests, style checks, etc.) turn green for a smooth merge.
55+
- Make sure all the checks (tests, style checks, etc.) turn green for a smooth merge.
5856

5957
### 4. **Receive an invitation to become a Maintainer 🎉**
6058

61-
- **Recognition**: After contributing consistently, the maintainers will invite you to join the team. This invitation is a recognition of your contributions and dedication.
62-
63-
- 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).
64-
65-
## Some Useful Links
59+
- **Recognition**: After contributing consistently, the maintainers will invite you to join the team. This invitation is a recognition of your contributions and dedication.
6660

67-
- [AsyncAPI Contributor’s Guide](https://github.com/asyncapi/cli/blob/master/CONTRIBUTING.md): Learn how to set up, contribute, and work on pull requests.
68-
- [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.
69-
- [AsyncAPI Slack Community](https://www.asyncapi.com/slack-invite): Join the community and interact with fellow contributors and maintainers.
61+
- 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).

0 commit comments

Comments
 (0)