Skip to content

Commit cca8cd9

Browse files
Aahil13thulieblack
andauthored
docs: add recognizing contributor and appointing new maintainers guide (#1964)
Co-authored-by: Aahil13 <onyeanunaprince@gmail.com> Co-authored-by: V Thulisile Sibanda <66913810+thulieblack@users.noreply.github.com>
1 parent d7f8e39 commit cca8cd9

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: 'Recognizing Contributors & Appointing New Maintainers'
3+
weight: 170
4+
---
5+
6+
AsyncAPI thrives on the passion, ideas, and time of its contributors. From reviewing PRs to improving documentation and hosting community calls, every contribution boosts our growth. This document outlines our process for recognizing contributors and appointing new maintainers across AsyncAPI projects.
7+
8+
## Recognizing contributors
9+
10+
Contributions can include, but are not limited to, any of the following:
11+
12+
- Submitting issues, PRs, or feedback
13+
- Reviewing and testing pull requests
14+
- Writing or editing documentation
15+
- Participating in design discussions
16+
- Creating community content (blogs, talks, onboardings)
17+
- Supporting others in Slack or GitHub issues
18+
- Proposing ideas that influence roadmap or architecture
19+
20+
### Recognition process
21+
22+
We use the [All Contributors](https://allcontributors.org/) specification to credit contributors across all AsyncAPI repositories.
23+
24+
To recognize someone:
25+
26+
1. Add a comment on the related issue or PR. For example:
27+
28+
```
29+
@all-contributors please add @username for doc, review
30+
```
31+
32+
2. Use the appropriate contribution types (like `code`, `doc`, `review`, `ideas`, etc.).
33+
34+
If you notice a contribution that wasn't acknowledged, speak up in [Slack](https://asyncapi.com/slack-invite) or [GitHub](https://github.com/asyncapi). We'll gladly fix it.
35+
36+
## Appointing new maintainers
37+
38+
The role of a maintainer is about demonstrating ownership, consistency, and care for the project and its people. In this section, we outline how we identify potential maintainers, the nomination process, and the onboarding steps.
39+
40+
### Selection criteria
41+
42+
Potential maintainers typically demonstrate:
43+
44+
- **Consistent quality contributions** across multiple PRs/issues.
45+
- **Responsiveness**: Participating in discussions, resolving feedback, and collaborating.
46+
- **Initiative**: Proactively suggesting or leading improvements, not just reacting to tasks.
47+
- **Community Mindset**: Supporting others, offering constructive feedback, and engaging in community spaces (like Slack or streams).
48+
- **Technical Alignment**: Understanding of project structure, workflows, and coding/documentation standards.
49+
50+
### Nomination process
51+
52+
Anyone can nominate a contributor for maintainership, including self-nominations.
53+
54+
1. **Raise a GitHub issue**: In the relevant repo, create a new issue titled `Nomination for Maintainer: @username`.
55+
2. **Summarize contributions**: Include links to PRs, issues, reviews, or community engagement.
56+
3. **Gather feedback**: Allow up to 7 days for community/maintainer feedback on the nomination.
57+
4. **Decision**: Core maintainers or [TSC](https://github.com/asyncapi/community/blob/master/docs/020-governance-and-policies/CHARTER.md#2-technical-steering-committee) will reach a consensus and respond on the issue.
58+
59+
### Onboarding checklist
60+
61+
When someone is approved as a new maintainer, the lead maintainer ensures the following onboarding steps are completed:
62+
63+
- [ ] Invite them as a GitHub maintainer with appropriate repo permissions
64+
- [ ] Add them to the [MAINTAINERS.yaml](https://github.com/asyncapi/community/blob/master/MAINTAINERS.yaml) file
65+
- [ ] Share [the Maintainer Onboarding Guide](https://www.asyncapi.com/docs/community/onboarding-guide/maintainer-guide)
66+
- [ ] Schedule a short onboarding call or Slack chat
67+
- [ ] Share the [TSC responsibilities and requirements](https://github.com/asyncapi/community/blob/master/docs/020-governance-and-policies/CHARTER.md#2-technical-steering-committee) from the Charter
68+
- [ ] Introduce them in the relevant Slack channels
69+
- [ ] Coordinate with the community manager and marketing team for a community-wide announcement, in addition to announcing it in their specific project repository
70+
71+
Maintainers are leaders. But leadership isn't about gatekeeping but rather helping others grow while keeping the project healthy and welcoming. Let's keep celebrating contributions of all shapes and sizes, and support new maintainers as they take on more responsibility.
72+
73+
Have a name in mind? Or would you like to nominate yourself? Head to the relevant repo and create a new Maintainer Nomination issue. Let's grow together.

0 commit comments

Comments
 (0)