-
-
Notifications
You must be signed in to change notification settings - Fork 114
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: add onboarding maintainers guide #1638
Open
Aahil13
wants to merge
12
commits into
asyncapi:master
Choose a base branch
from
Aahil13:onboarding-maintainers-guide
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
80084ae
docs: Add onboarding maintainers guide
Aahil13 25e57e2
Merge branch 'asyncapi:master' into onboarding-maintainers-guide
Aahil13 f2fbe41
docs: updated review changes
Aahil13 f7023e8
docs: updated review changes
Aahil13 a099041
Merge branch 'asyncapi:master' into onboarding-maintainers-guide
Aahil13 e4a3586
docs: updated review changes
Aahil13 49a16e1
docs: fix inconsistent formatting
Aahil13 3589a44
Merge branch 'asyncapi:master' into onboarding-maintainers-guide
Aahil13 334faea
docs: add more maintainer roles
Aahil13 8497209
Merge branch 'asyncapi:master' into onboarding-maintainers-guide
Aahil13 252c998
Update docs/onboarding-guide/Onboarding-maintainer-guide.md
Aahil13 76b863b
Update docs/onboarding-guide/Onboarding-maintainer-guide.md
Aahil13 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,62 @@ | ||||||
# Onboarding Guide for AsyncAPI Maintainers | ||||||
|
||||||
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. | ||||||
|
||||||
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'll be responsible for: | ||||||
|
||||||
- Overseeing the technical direction of the project | ||||||
- Helping with reviewing and resolving issues and pull requests (PR) | ||||||
- Managing workflows and GitHub Actions to automate tasks | ||||||
- Enforcing coding standards | ||||||
Aahil13 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
- Identifying and appointing new maintainers | ||||||
- 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. | ||||||
|
||||||
## 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 [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. | ||||||
|
||||||
- **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. | ||||||
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
|
||||||
|
||||||
### 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). | ||||||
|
||||||
- **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 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 PR merged** | ||||||
|
||||||
- **PR review process**: After submitting a PR, maintainers need to review it. | ||||||
|
||||||
- **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. | ||||||
|
||||||
### 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 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). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.